com.plumtree.server
Interface IPTSchedule

All Superinterfaces:
IPTUnknown

public interface IPTSchedule
extends IPTUnknown


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

GetScheduleType

public int GetScheduleType()
Retrieves the schedule type of this schedule The schedule type indicates whether it is recurring or a one time launch
Returns:
an int corresponding to a PT_SCHEDULETYPES

SetScheduleType

public void SetScheduleType(int Value)
Sets the schedule type of this schedule The schedule type indicates whether it is recurring or a one time launch
Parameters:
Value - an int corresponding to a PT_SCHEDULETYPES

GetRecurrenceInterval

public int GetRecurrenceInterval()
Returns the interval multiplier Recurring schedules recur every RecurrenceInterval . The units are specified in the ScheduleType.
Returns:
an int used as the multiplier to the PT_SCHEDULTYPES interval

SetRecurrenceInterval

public void SetRecurrenceInterval(int Value)
Sets the interval multiplier Recurring schedules recur every RecurrenceInterval . The units are specified in the ScheduleType.
Parameters:
Value - an int used as the multiplier to the PT_SCHEDULTYPES interval

GetStartTimestamp

public com.plumtree.openfoundation.util.XPDateTime GetStartTimestamp()
Returns Start Timestamp. The timestamp is rounded to the nearest minute.
Returns:
an XPDateTime as the Starting Time Stamp

SetStartTimestamp

public void SetStartTimestamp(com.plumtree.openfoundation.util.XPDateTime Value)
Sets Start Timestamp. The timestamp is rounded to the nearest minute.
Parameters:
Value - an XPDateTime as the Starting Time Stamp

GetUntilTimestamp

public com.plumtree.openfoundation.util.XPDateTime GetUntilTimestamp()
Returns final date after which job should not run
Returns:
An XPDateTime value for the last scheduled runtime

SetUntilTimestamp

public void SetUntilTimestamp(com.plumtree.openfoundation.util.XPDateTime Value)
Sets final date after which job should not run
Parameters:
Value - an XPDateTime representing the final date

CalculateNextRuntime

public com.plumtree.openfoundation.util.XPDateTime CalculateNextRuntime(com.plumtree.openfoundation.util.XPDateTime dtNextRuntimeAfter)
Computes the next time of execution based on a given date
Parameters:
dtNextRuntimeAfter - an XPDateTime after which an execution date is computed
Returns:
an XPDateTime representing the next scheduled execution date after the date given

GetSettingsAsInt

public int GetSettingsAsInt(int ScheduleSetting)
Queries values for PT_SCHEDULE_SETTINGS
Parameters:
ScheduleSetting - a PT_SCHEDULE_SETTINGS for schedule suspension parameters
Returns:
an int value for checking the interval or suspension mode

GetSettingsAsString

public java.lang.String GetSettingsAsString(int ScheduleSetting)
Returns the value for a PT_SCHEDULE_SETTINGS in a String format
Parameters:
ScheduleSetting - a PT_SCHEDULE_SETTINGS member
Returns:
a String converted from an int or XPDateTime for the requested setting

SetSettings

public void SetSettings(int Value,
                        int pvValue)
Sets the value for a PT_SCHEDULE_SETTINGS for interval or suspension mode.
Parameters:
Value - a PT_SCHEDULE_SETTINGS member
pvValue - an int for the requested setting

SetSettings

public void SetSettings(int Value,
                        java.lang.String pvValue)
Sets the value for a PT_SCHEDULE_SETTINGS. Wherever possible the SetSettings method taking in an int or XPDateTime is much preferred to this method.
Parameters:
Value - a PT_SCHEDULE_SETTINGS member
pvValue - a String for the requested setting

SetSettings

public void SetSettings(int Value,
                        java.lang.Object pvValue)
Sets the value for a PT_SCHEDULE_SETTINGS.
Parameters:
Value - a PT_SCHEDULE_SETTINGS member
pvValue - an XPDateTime for the requested setting

IsTimeToSuspend

public boolean IsTimeToSuspend()
A utility method used by the server to poll for suspension requests.
Returns:
a boolean, if true, indicates need for suspension.

IsTimeToSaveCheckpoint

public boolean IsTimeToSaveCheckpoint()
A utility method used by the server to poll for checkpoint requests.
Returns:
a boolean, if true, indicates need for saving checkpoint.

CalculateNextRuntimeForSuspendedJob

public com.plumtree.openfoundation.util.XPDateTime CalculateNextRuntimeForSuspendedJob()
Computes the next time to suspend this operation
Returns:
an XPDateTime representing the next scheduled suspension time.


Copyright © 2003 Plumtree Software Inc. All Rights Reserved.