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

public class ScheduleInstance
extends AbstractSchedule

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:

• Serialized Form

Field Summary

Fields inherited from interface com.appiancorp.suiteapi.common.XMLable

DEFAULT_BUFFER_SIZE

Constructor Summary

Constructors

Constructor	Description
ScheduleInstance()

Method Summary

Modifier and Type	Method	Description
Boolean	getHasTriggered()	Informs if the scheduled event has triggered in the past.
Timestamp	getTimeStampScheduled()	Retrieves the timestamp of the time at which the event is scheduled
void	setHasTriggered(Boolean triggered_)	Sets if the scheduled event has triggered
void	setTimeStampScheduled(Timestamp stampTriggered_)	Sets the timestamp of the time
void	toXML(StringBuilder buffer_)	Adds the XML representation of the object to the buffer

Methods inherited from class com.appiancorp.suiteapi.process.AbstractSchedule

getAbsoluteExpression, getAbsoluteOrRelative, getAbsoluteTime, getRecurring, getRelativeInterval, isAbsoluteDelay, setAbsoluteDelay, setAbsoluteExpression, setAbsoluteOrRelative, setAbsoluteTime, setRecurring, setRelativeInterval, toXML

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.appiancorp.suiteapi.common.XMLable

toXML

Constructor Details

ScheduleInstance

public ScheduleInstance()

Method Details

toXML

public void toXML(StringBuilder buffer_)

Adds the XML representation of the object to the buffer

Specified by:

toXML in interface XMLable

Overrides:

toXML in class AbstractSchedule

Parameters:

buffer_ - StringBuilder that's populated with the XML representation of the Schedule object

getHasTriggered

public Boolean getHasTriggered()

Informs if the scheduled event has triggered in the past.

Returns:

true if the scheduled event is over else false

setHasTriggered

public void setHasTriggered(Boolean triggered_)

Sets if the scheduled event has triggered

Parameters:

triggered_ -

getTimeStampScheduled

public Timestamp getTimeStampScheduled()

Retrieves the timestamp of the time at which the event is scheduled

Returns:

timestamp of the event

setTimeStampScheduled

public void setTimeStampScheduled(Timestamp stampTriggered_)

Sets the timestamp of the time

Parameters:

stampTriggered_ - timestamp of the time