Package com.carfey.ops.api.bean.schedule

Class AbstractScheduleCreationRequest<T extends AbstractScheduleCreationRequest<?>>

java.lang.Object

com.carfey.ops.api.bean.schedule.AbstractScheduleCreationRequest<T>

Direct Known Subclasses:

ScheduleCreationRequest, ScheduleSaveRequest

public abstract class AbstractScheduleCreationRequest<T extends AbstractScheduleCreationRequest<?>>
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field	Description
protected com.carfey.jdk.lang.DateTime	effectiveDate
protected com.carfey.jdk.lang.DateTime	endDate
protected java.lang.String	schedule
protected JobStatus	state

Constructor Summary

Constructors

Constructor	Description
AbstractScheduleCreationRequest()

Method Summary

Modifier and Type	Method	Description
com.carfey.jdk.lang.DateTime	getEffectiveDate()	The initial schedule effective date, if not effective immediately.
com.carfey.jdk.lang.DateTime	getEndDate()	The schedule end date, if not effective forever.
java.util.List<OrdinalConfigurationParameters>	getOrdinalParameters()	Prior to 3.8.0, this was called getParameters and was what is now at OrdinalConfigurationParameters.getParameters()
java.lang.String	getSchedule()	Required in some cases.
JobStatus	getState()	Required field.
void	setEffectiveDate(com.carfey.jdk.lang.DateTime effectiveDate)
void	setEndDate(com.carfey.jdk.lang.DateTime endDate)
void	setOrdinalParameters(java.util.List<OrdinalConfigurationParameters> ordinalParameters)
void	setSchedule(java.lang.String schedule)
void	setState(JobStatus state)
java.lang.String	toString()
T	withEffectiveDate(com.carfey.jdk.lang.DateTime effectiveDate)
T	withEndDate(com.carfey.jdk.lang.DateTime endDate)
T	withOrdinalParameters(java.util.List<OrdinalConfigurationParameters> ordinalParameters)
T	withSchedule(java.lang.String schedule)
T	withState(JobStatus state)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

schedule

@FieldProperty(displayName="schedule",
               required=false)
protected java.lang.String schedule

state

@FieldProperty(displayName="state",
               maxLength=50,
               required=true)
protected JobStatus state

effectiveDate

protected com.carfey.jdk.lang.DateTime effectiveDate

endDate

protected com.carfey.jdk.lang.DateTime endDate

Constructor Detail

AbstractScheduleCreationRequest

public AbstractScheduleCreationRequest()

Method Detail

getState

public JobStatus getState()

Required field. The job schedule state. See JobStatus.

Returns:

job status

setState

public void setState(JobStatus state)

withState

public T withState(JobStatus state)

getSchedule

public java.lang.String getSchedule()

Required in some cases. The job schedule pattern , if applicable for the state.

Returns:

schedule

setSchedule

public void setSchedule(java.lang.String schedule)

withSchedule

public T withSchedule(java.lang.String schedule)

getEffectiveDate

public com.carfey.jdk.lang.DateTime getEffectiveDate()

The initial schedule effective date, if not effective immediately.

Returns:

effective date

setEffectiveDate

public void setEffectiveDate(com.carfey.jdk.lang.DateTime effectiveDate)

withEffectiveDate

public T withEffectiveDate(com.carfey.jdk.lang.DateTime effectiveDate)

getEndDate

public com.carfey.jdk.lang.DateTime getEndDate()

The schedule end date, if not effective forever.

Returns:

end date

setEndDate

public void setEndDate(com.carfey.jdk.lang.DateTime endDate)

withEndDate

public T withEndDate(com.carfey.jdk.lang.DateTime endDate)

getOrdinalParameters

public java.util.List<OrdinalConfigurationParameters> getOrdinalParameters()

Prior to 3.8.0, this was called getParameters and was what is now at OrdinalConfigurationParameters.getParameters()

Returns:

ordinal parameters

Since:

3.8.0

setOrdinalParameters

public void setOrdinalParameters(java.util.List<OrdinalConfigurationParameters> ordinalParameters)

withOrdinalParameters

public T withOrdinalParameters(java.util.List<OrdinalConfigurationParameters> ordinalParameters)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object