com.crystaldecisions.sdk.occa.infostore
Interface ISchedulable

All Known Subinterfaces:

IFullClient, INotificationSchedule, IObjectPackage, IProbeInfoObject, IProgram, IPublication, IReplication, IReport, IScopeBatch, IWebi

public interface ISchedulable

Method Summary

java.util.Date	getEndTime() Returns the end time of this instance.
IInfoObjects	getInstances() Retrieves all the instances connected to this object.
IInfoObjects	getInstances(int propertySet, SearchPattern searchPattern, SortType sortType) Retrieves instances connected to this object.
IInfoObject	getLatestInstance() Retrieves the latest instance of this object.
IInfoObject	getLatestInstance(int propertySet, SearchPattern searchPattern) Retrieves instances connected to this object.
ISchedulingInfo	getSchedulingInfo() Retrieves the scheduling parameters
java.util.Date	getStartTime() Returns the start time of this instance.
void	schedule() Schedules the object.

Method Detail

schedule

void schedule()
              throws SDKException

Schedules the object.

Throws:

SDKException

getSchedulingInfo

ISchedulingInfo getSchedulingInfo()

Retrieves the scheduling parameters

Returns:

A ISchedulingInfo that defines the scheduling parameters

InfoObject properties to query for:

SI_SCHEDULEINFO

getInstances

IInfoObjects getInstances()
                          throws SDKException

Retrieves all the instances connected to this object.

Returns:

A IInfoObjects collection.

Throws:

SDKException

getInstances

IInfoObjects getInstances(int propertySet,
                          SearchPattern searchPattern,
                          SortType sortType)
                          throws SDKException

Retrieves instances connected to this object.

Parameters:

propertSet - The IInfoObject.propertySet to get from the repository.

searchPattern - The SearchPattern to use to find an object.

sortType - The SortType to sort the list of objects retrieved from the repository.

Returns:

The IInfoObjects collection.

Throws:

SDKException

getLatestInstance

IInfoObject getLatestInstance()
                              throws SDKException

Retrieves the latest instance of this object.

Returns:

The IInfoObject that is the latest instance.

Throws:

SDKException

getLatestInstance

IInfoObject getLatestInstance(int propertySet,
                              SearchPattern searchPattern)
                              throws SDKException

Retrieves instances connected to this object.

Parameters:

propertSet - The IInfoObject.propertySet to get from the repository.

searchPattern - The SearchPattern to use to find an object.

Returns:

The IInfoObject collection.

Throws:

SDKException

getStartTime

java.util.Date getStartTime()

Returns the start time of this instance.

Returns:

Date as the start time of this instance.

Since:

13.0

InfoObject properties to query for:

SI_STARTTIME

getEndTime

java.util.Date getEndTime()

Returns the end time of this instance.

Returns:

Date as the end time of this instance.

Since:

13.0

InfoObject properties to query for:

SI_ENDTIME