Package com.mypurecloud.sdk.v2.model

Class BuShortTermForecast

java.lang.Object

com.mypurecloud.sdk.v2.model.BuShortTermForecast

All Implemented Interfaces:

Serializable

public class BuShortTermForecast
extends Object
implements Serializable

BuShortTermForecast

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	BuShortTermForecast.CreationMethodEnum	The method by which this forecast was created

Constructor Summary

Constructors

Constructor	Description
BuShortTermForecast()
BuShortTermForecast(Boolean initWithEmptyList)

Method Summary

Modifier and Type	Method	Description
BuShortTermForecast	canUseForScheduling(Boolean canUseForScheduling)	Whether this forecast can be used for scheduling
BuShortTermForecast	creationMethod(BuShortTermForecast.CreationMethodEnum creationMethod)	The method by which this forecast was created
BuShortTermForecast	description(String description)	The description of this forecast
boolean	equals(Object o)
BuShortTermForecast	generationResults(BuForecastGenerationResult generationResults)	Generation result metadata
Boolean	getCanUseForScheduling()
BuShortTermForecast.CreationMethodEnum	getCreationMethod()
String	getDescription()
BuForecastGenerationResult	getGenerationResults()
String	getId()
Boolean	getLegacy()
WfmVersionedEntityMetadata	getMetadata()
List<BuForecastModificationResponse>	getModifications()
ForecastPlanningGroupsResponse	getPlanningGroups()
Integer	getPlanningGroupsVersion()
Date	getReferenceStartDate()
String	getSelfUri()
List<ForecastSourceDayPointer>	getSourceDays()
String	getTimeZone()
Integer	getWeekCount()
LocalDate	getWeekDate()
int	hashCode()
BuShortTermForecast	id(String id)	The globally unique identifier for the object.
BuShortTermForecast	metadata(WfmVersionedEntityMetadata metadata)	Metadata for this forecast
BuShortTermForecast	modifications(List<BuForecastModificationResponse> modifications)	Any manual modifications applied to this forecast
BuShortTermForecast	planningGroups(ForecastPlanningGroupsResponse planningGroups)	A snapshot of the planning groups used for this forecast as of the version number indicated
BuShortTermForecast	planningGroupsVersion(Integer planningGroupsVersion)	The version of the planning groups that was used for this forecast
BuShortTermForecast	referenceStartDate(Date referenceStartDate)	The reference start date for interval-based data for this forecast.
void	setCanUseForScheduling(Boolean canUseForScheduling)
void	setCreationMethod(BuShortTermForecast.CreationMethodEnum creationMethod)
void	setDescription(String description)
void	setGenerationResults(BuForecastGenerationResult generationResults)
void	setId(String id)
void	setMetadata(WfmVersionedEntityMetadata metadata)
void	setModifications(List<BuForecastModificationResponse> modifications)
void	setPlanningGroups(ForecastPlanningGroupsResponse planningGroups)
void	setPlanningGroupsVersion(Integer planningGroupsVersion)
void	setReferenceStartDate(Date referenceStartDate)
void	setSourceDays(List<ForecastSourceDayPointer> sourceDays)
void	setTimeZone(String timeZone)
void	setWeekCount(Integer weekCount)
void	setWeekDate(LocalDate weekDate)
BuShortTermForecast	sourceDays(List<ForecastSourceDayPointer> sourceDays)	The source day pointers for this forecast
BuShortTermForecast	timeZone(String timeZone)	The time zone for this forecast
String	toString()
BuShortTermForecast	weekCount(Integer weekCount)	The number of weeks this forecast covers
BuShortTermForecast	weekDate(LocalDate weekDate)	The start week date of this forecast in yyyy-MM-dd.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

BuShortTermForecast

public BuShortTermForecast()

BuShortTermForecast

public BuShortTermForecast(Boolean initWithEmptyList)

Method Details

id

public BuShortTermForecast id(String id)

The globally unique identifier for the object.

getId

public String getId()

setId

public void setId(String id)

weekDate

public BuShortTermForecast weekDate(LocalDate weekDate)

The start week date of this forecast in yyyy-MM-dd. Must fall on the start day of week for the associated business unit. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd

getWeekDate

public LocalDate getWeekDate()

setWeekDate

public void setWeekDate(LocalDate weekDate)

weekCount

public BuShortTermForecast weekCount(Integer weekCount)

The number of weeks this forecast covers

getWeekCount

public Integer getWeekCount()

setWeekCount

public void setWeekCount(Integer weekCount)

creationMethod

public BuShortTermForecast creationMethod(BuShortTermForecast.CreationMethodEnum creationMethod)

The method by which this forecast was created

getCreationMethod

public BuShortTermForecast.CreationMethodEnum getCreationMethod()

setCreationMethod

public void setCreationMethod(BuShortTermForecast.CreationMethodEnum creationMethod)

description

public BuShortTermForecast description(String description)

The description of this forecast

getDescription

public String getDescription()

setDescription

public void setDescription(String description)

getLegacy

public Boolean getLegacy()

metadata

public BuShortTermForecast metadata(WfmVersionedEntityMetadata metadata)

Metadata for this forecast

getMetadata

public WfmVersionedEntityMetadata getMetadata()

setMetadata

public void setMetadata(WfmVersionedEntityMetadata metadata)

canUseForScheduling

public BuShortTermForecast canUseForScheduling(Boolean canUseForScheduling)

Whether this forecast can be used for scheduling

getCanUseForScheduling

public Boolean getCanUseForScheduling()

setCanUseForScheduling

public void setCanUseForScheduling(Boolean canUseForScheduling)

referenceStartDate

public BuShortTermForecast referenceStartDate(Date referenceStartDate)

The reference start date for interval-based data for this forecast. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z

getReferenceStartDate

public Date getReferenceStartDate()

setReferenceStartDate

public void setReferenceStartDate(Date referenceStartDate)

sourceDays

public BuShortTermForecast sourceDays(List<ForecastSourceDayPointer> sourceDays)

The source day pointers for this forecast

getSourceDays

public List<ForecastSourceDayPointer> getSourceDays()

setSourceDays

public void setSourceDays(List<ForecastSourceDayPointer> sourceDays)

modifications

public BuShortTermForecast modifications(List<BuForecastModificationResponse> modifications)

Any manual modifications applied to this forecast

getModifications

public List<BuForecastModificationResponse> getModifications()

setModifications

public void setModifications(List<BuForecastModificationResponse> modifications)

generationResults

public BuShortTermForecast generationResults(BuForecastGenerationResult generationResults)

Generation result metadata

getGenerationResults

public BuForecastGenerationResult getGenerationResults()

setGenerationResults

public void setGenerationResults(BuForecastGenerationResult generationResults)

timeZone

public BuShortTermForecast timeZone(String timeZone)

The time zone for this forecast

getTimeZone

public String getTimeZone()

setTimeZone

public void setTimeZone(String timeZone)

planningGroupsVersion

public BuShortTermForecast planningGroupsVersion(Integer planningGroupsVersion)

The version of the planning groups that was used for this forecast

getPlanningGroupsVersion

public Integer getPlanningGroupsVersion()

setPlanningGroupsVersion

public void setPlanningGroupsVersion(Integer planningGroupsVersion)

planningGroups

public BuShortTermForecast planningGroups(ForecastPlanningGroupsResponse planningGroups)

A snapshot of the planning groups used for this forecast as of the version number indicated

getPlanningGroups

public ForecastPlanningGroupsResponse getPlanningGroups()

setPlanningGroups

public void setPlanningGroups(ForecastPlanningGroupsResponse planningGroups)

getSelfUri

public String getSelfUri()

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object