|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IPTSchedule
Method Summary | |
---|---|
com.plumtree.openfoundation.util.XPDateTime |
CalculateNextRuntime(com.plumtree.openfoundation.util.XPDateTime dtNextRuntimeAfter)
Computes the next time of execution based on a given date |
com.plumtree.openfoundation.util.XPDateTime |
CalculateNextRuntimeForSuspendedJob()
Computes the next time to suspend this operation |
int |
GetRecurrenceInterval()
Returns the interval multiplier Recurring schedules recur every RecurrenceInterval |
int |
GetScheduleType()
Retrieves the schedule type of this schedule The schedule type indicates whether it is recurring or a one time launch |
int |
GetSettingsAsInt(int ScheduleSetting)
Queries values for PT_SCHEDULE_SETTINGS |
java.lang.String |
GetSettingsAsString(int ScheduleSetting)
Returns the value for a PT_SCHEDULE_SETTINGS in a String format |
com.plumtree.openfoundation.util.XPDateTime |
GetStartTimestamp()
Returns Start Timestamp. |
com.plumtree.openfoundation.util.XPDateTime |
GetUntilTimestamp()
Returns final date after which job should not run |
boolean |
IsTimeToSaveCheckpoint()
A utility method used by the server to poll for checkpoint requests. |
boolean |
IsTimeToSuspend()
A utility method used by the server to poll for suspension requests. |
void |
SetRecurrenceInterval(int Value)
Sets the interval multiplier Recurring schedules recur every RecurrenceInterval |
void |
SetScheduleType(int Value)
Sets the schedule type of this schedule The schedule type indicates whether it is recurring or a one time launch |
void |
SetSettings(int Value,
int pvValue)
Sets the value for a PT_SCHEDULE_SETTINGS for interval or suspension mode. |
void |
SetSettings(int Value,
java.lang.Object pvValue)
Sets the value for a PT_SCHEDULE_SETTINGS. |
void |
SetSettings(int Value,
java.lang.String pvValue)
Sets the value for a PT_SCHEDULE_SETTINGS. |
void |
SetStartTimestamp(com.plumtree.openfoundation.util.XPDateTime Value)
Sets Start Timestamp. |
void |
SetUntilTimestamp(com.plumtree.openfoundation.util.XPDateTime Value)
Sets final date after which job should not run |
Methods inherited from interface com.plumtree.server.IPTUnknown |
---|
GetInterfaces |
Method Detail |
---|
int GetScheduleType()
void SetScheduleType(int Value)
Value
- an int corresponding to a PT_SCHEDULETYPESint GetRecurrenceInterval()
void SetRecurrenceInterval(int Value)
Value
- an int used as the multiplier to the PT_SCHEDULTYPES intervalcom.plumtree.openfoundation.util.XPDateTime GetStartTimestamp()
void SetStartTimestamp(com.plumtree.openfoundation.util.XPDateTime Value)
Value
- an XPDateTime as the Starting Time Stampcom.plumtree.openfoundation.util.XPDateTime GetUntilTimestamp()
void SetUntilTimestamp(com.plumtree.openfoundation.util.XPDateTime Value)
Value
- an XPDateTime representing the final datecom.plumtree.openfoundation.util.XPDateTime CalculateNextRuntime(com.plumtree.openfoundation.util.XPDateTime dtNextRuntimeAfter)
dtNextRuntimeAfter
- an XPDateTime after which an execution date is computed
int GetSettingsAsInt(int ScheduleSetting)
ScheduleSetting
- a PT_SCHEDULE_SETTINGS for schedule suspension parameters
java.lang.String GetSettingsAsString(int ScheduleSetting)
ScheduleSetting
- a PT_SCHEDULE_SETTINGS member
void SetSettings(int Value, int pvValue)
Value
- a PT_SCHEDULE_SETTINGS memberpvValue
- an int for the requested settingvoid SetSettings(int Value, java.lang.String pvValue)
Value
- a PT_SCHEDULE_SETTINGS memberpvValue
- a String for the requested settingvoid SetSettings(int Value, java.lang.Object pvValue)
Value
- a PT_SCHEDULE_SETTINGS memberpvValue
- an XPDateTime for the requested settingboolean IsTimeToSuspend()
boolean IsTimeToSaveCheckpoint()
com.plumtree.openfoundation.util.XPDateTime CalculateNextRuntimeForSuspendedJob()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |