public interface ScheduleEvaluateCmd extends TaskCommand
computeFullSchedule()
method
computeNextOccurrence()
method
The usage of this command is decided based on whether it is set to compute the
entire schedule setComputeFullSchedule()
or set
to compute only the next occurrence setComputeNextOccurenceFromSchedule()
Modifier and Type | Interface and Description |
---|---|
static class |
ScheduleEvaluateCmd.UnitOfMeasure
The unit of measures supported for frequency.
|
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
COPYRIGHT
The copy right field.
|
static java.lang.String |
NAME
The name of the interface.
|
Modifier and Type | Method and Description |
---|---|
void |
computeFullSchedule()
This method computes the complete schedule information using the schedule information provided
through
ScheduleInfoType that was set using setScheduleToEvaluate method. |
void |
computeNextOccurrence()
This method computes the next occurrence of the schedule using the
previous occurrence info and the schedule information specified through
the
ScheduleInfoType that was set in the setScheduleToEvaluate method. |
boolean |
isScheduleEnded()
This method evaluates the schedule provided and indicates if the schedule
has ended.
|
java.util.Date |
nextOccurrence()
This method returns the next occurrence using the schedule information
specified.
|
void |
setComputeFullSchedule()
This method is used to indicate to the command that the full schedule
needs to be computed.
|
void |
setComputeNextOccurenceFromSchedule()
This method is used to indicate to the command that only the next
occurrence of the schedule needs to be computed based on its previous
occurrence.
|
void |
setPreviousOccurrence(java.util.Date previousOccurrence)
This method sets the previous occurrence of the schedule.
|
void |
setScheduleToEvaluate(com.ibm.commerce.foundation.common.datatypes.ScheduleInfoType scheduleInfo)
Sets the schedule information instance to evaluate.
|
void |
validateSchedule()
This method validates the schedule information provided.
|
executeFromCache, getCaller, getEntryInfo, getId, getSharingPolicy, postExecute, preExecute, setCaller, updateCache
getCommandTarget, getCommandTargetName, hasOutputProperties, performExecute, setCommandTarget, setCommandTargetName, setOutputProperties
checkIsAllowed, checkResourcePermission, createCommandExecutionEvent, getAccCheck, getCommandContext, getCommandIfName, getCommandName, getCommandStoreId, getDefaultProperties, getExceptionInvokeParameters, getPostInvokeParameters, getPreInvokeParameters, getResources, getStoreId, getUser, getUserId, performExecute, setAccCheck, setCommandContext, setCommandIfName, setCommandStoreId, setDefaultProperties, validateParameters
static final java.lang.String COPYRIGHT
static final java.lang.String NAME
void setScheduleToEvaluate(com.ibm.commerce.foundation.common.datatypes.ScheduleInfoType scheduleInfo)
scheduleInfo
- The schedule information instance to evaluate.void computeFullSchedule() throws com.ibm.commerce.foundation.internal.common.exception.FoundationApplicationException
ScheduleInfoType
that was set using setScheduleToEvaluate
method.
The method validates the information in the ScheduleInfoType
and computes the total
number of occurrences, duration or the end date related info based on the input values specified.
It then saves the fully computed schedule information back into ScheduleInfoType
.com.ibm.commerce.foundation.internal.common.exception.FoundationApplicationException
void computeNextOccurrence() throws com.ibm.commerce.foundation.internal.common.exception.FoundationApplicationException
ScheduleInfoType
that was set in the setScheduleToEvaluate
method.
It then saves the computed value back into ScheduleInfoType
.com.ibm.commerce.foundation.internal.common.exception.FoundationApplicationException
java.util.Date nextOccurrence()
void validateSchedule() throws com.ibm.commerce.foundation.internal.common.exception.FoundationApplicationException
com.ibm.commerce.foundation.internal.common.exception.FoundationApplicationException
void setPreviousOccurrence(java.util.Date previousOccurrence)
previousOccurrence
- The previous occurrence of the schedule.boolean isScheduleEnded()
void setComputeFullSchedule()
void setComputeNextOccurenceFromSchedule()