Package com.appiancorp.suiteapi.process
Class ScheduleInstance
java.lang.Object
com.appiancorp.suiteapi.process.AbstractSchedule
com.appiancorp.suiteapi.process.ScheduleInstance
- All Implemented Interfaces:
XMLable
,Serializable
A Schedule is used to define a time for an event based either on an absolute
Timestamp or relative to some other event. If the delay is absolute then the
timer expires at an exact time, i.e. 12:52AM on 12/18/2007. A relative delay
occurs at some offset to another event, such as the activation of a node or
process, such as 2 hours and 18 minutes afterwards.
- See Also:
-
Field Summary
Fields inherited from interface com.appiancorp.suiteapi.common.XMLable
DEFAULT_BUFFER_SIZE
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionInforms if the scheduled event has triggered in the past.Retrieves the timestamp of the time at which the event is scheduledvoid
setHasTriggered
(Boolean triggered_) Sets if the scheduled event has triggeredvoid
setTimeStampScheduled
(Timestamp stampTriggered_) Sets the timestamp of the timevoid
toXML
(StringBuilder buffer_) Adds the XML representation of the object to the bufferMethods inherited from class com.appiancorp.suiteapi.process.AbstractSchedule
getAbsoluteExpression, getAbsoluteOrRelative, getAbsoluteTime, getRecurring, getRelativeInterval, isAbsoluteDelay, setAbsoluteDelay, setAbsoluteExpression, setAbsoluteOrRelative, setAbsoluteTime, setRecurring, setRelativeInterval, toXML
-
Constructor Details
-
ScheduleInstance
public ScheduleInstance()
-
-
Method Details
-
toXML
Adds the XML representation of the object to the buffer- Specified by:
toXML
in interfaceXMLable
- Overrides:
toXML
in classAbstractSchedule
- Parameters:
buffer_
- StringBuilder that's populated with the XML representation of the Schedule object
-
getHasTriggered
Informs if the scheduled event has triggered in the past.- Returns:
- true if the scheduled event is over else false
-
setHasTriggered
Sets if the scheduled event has triggered- Parameters:
triggered_
-
-
getTimeStampScheduled
Retrieves the timestamp of the time at which the event is scheduled- Returns:
- timestamp of the event
-
setTimeStampScheduled
Sets the timestamp of the time- Parameters:
stampTriggered_
- timestamp of the time
-