com.webmethods.portal.bizPolicy.biz.meta.schedule

Interface ISchedulePolicy

All Superinterfaces:

IBizPolicy, IComponent, IInitializable, ISystemHandler, IViewableContainerPolicy, IViewablePolicy

public interface ISchedulePolicy
extends IViewableContainerPolicy

Policy for working with scheduled events.

Method Summary

Modifier and Type	Method and Description
IThingID	createSchedule(IContext context, String interval, String timeAt, String eventName) This will invoke the appropriate ICommand with the appropriate IContext Creates a schedule with the specified information.
void	destroySchedule(IContext context, IThingID scheduleID) This will invoke the appropriate ICommand with the appropriate IContext Destroys the specified schedule.
IListView<IView>	listSchedules(IContext context, String view) Returns an IListView of schedules in the system
void	setNextTime(IContext context, IThingID scheduleID, long nextTime) This will invoke the appropriate ICommand with the appropriate IContext Set the next firing time for the specified schedule.
void	setSchedulePaused(IContext context, IThingID scheduleID, boolean paused) Pauses/resumes a schedule.
void	setScheduleProperties(IContext context, IThingID scheduleID, String interval, String timeAt, String eventName) This will invoke the appropriate ICommand with the appropriate IContext Sets the properties of the specified schedule.
void	triggerSchedule(IContext context, IThingID scheduleID) Causes an event to be fired for the schedule as if it's scheduled time was now.

Methods inherited from interface com.webmethods.portal.bizPolicy.biz.view.IViewableContainerPolicy

getPagingCookie, getPagingCookie, pageBackward, pageForeward, setPagingCookie

Methods inherited from interface com.webmethods.portal.bizPolicy.biz.view.IViewablePolicy

getIcon, view

Methods inherited from interface com.webmethods.portal.system.IComponent

getComponentData, getComponentName, getComponentProvider, getURI, isInitialized, setComponentData, setComponentProvider

Methods inherited from interface com.webmethods.portal.system.init.IInitializable

init, shutdown

Method Detail

createSchedule

IThingID createSchedule(IContext context,
                        String interval,
                        String timeAt,
                        String eventName)
                 throws BizException

This will invoke the appropriate ICommand with the appropriate IContext Creates a schedule with the specified information.

Parameters:

context - Context state information (current user, etc.).

interval - for the schedule in ISO8601 format (ex. 2D - every 2 days)

timeAt - firing time for the schedule in ISO8601 format (ex. 14:00:00 - at 2 pm)

eventName - name of the schedule

Returns:

IThingID of the newly created schedule

Throws:

BizException

destroySchedule

void destroySchedule(IContext context,
                     IThingID scheduleID)
              throws BizException

This will invoke the appropriate ICommand with the appropriate IContext Destroys the specified schedule.

Parameters:

context - Context state information (current user, etc.).

scheduleID - IThingID of the schedule to destroy

Throws:

BizException

setScheduleProperties

void setScheduleProperties(IContext context,
                           IThingID scheduleID,
                           String interval,
                           String timeAt,
                           String eventName)
                    throws BizException

This will invoke the appropriate ICommand with the appropriate IContext Sets the properties of the specified schedule. Properties that are not being changed may be left null.

Parameters:

context - Context state information (current user, etc.).

scheduleID - IThingID of the schedule whose properties to modify

interval - for the scheduled in ISO8601 format (ex. 2D - every 2 days)

timeAt - timeAt firing time for the scheduled in ISO8601 format (ex. 14:00:00 - at 2 pm)

eventName - name of the schedule

Throws:

BizException

setNextTime

void setNextTime(IContext context,
                 IThingID scheduleID,
                 long nextTime)
          throws BizException

This will invoke the appropriate ICommand with the appropriate IContext Set the next firing time for the specified schedule.

Parameters:

context - Context state information (current user, etc.).

scheduleID - IThingID of the schedule to modify

nextTime - next firing time for the schedule

Throws:

BizException

setSchedulePaused

void setSchedulePaused(IContext context,
                       IThingID scheduleID,
                       boolean paused)
                throws BizException

Pauses/resumes a schedule.

Parameters:

context - Context state information (current user, etc.).

scheduleID - IThingID of the schedule to pause/resume

paused - the paused flag. true pauses, false resumes.

Throws:

BizException

triggerSchedule

void triggerSchedule(IContext context,
                     IThingID scheduleID)
              throws BizException

Causes an event to be fired for the schedule as if it's scheduled time was now.

Parameters:

context - Context state information (current user, etc.).

scheduleID - IThingID of the schedule to trigger

Throws:

BizException

listSchedules

IListView<IView> listSchedules(IContext context,
                               String view)
                        throws BizException

Returns an IListView of schedules in the system

Parameters:

context - Context state information (current user, etc.).

view - Name of view.

Returns:

list of schedules in the system

Throws:

BizException