| org.sakaiproject.api.app.scheduler.ScheduledInvocationManager
All known Subclasses: org.sakaiproject.component.app.scheduler.ScheduledInvocationManagerImpl,
ScheduledInvocationManager | public interface ScheduledInvocationManager (Code) | | |
Method Summary | |
public String | createDelayedInvocation(Time time, String componentId, String opaqueContext) Creates a new delayed invocation and returns the unique id of the created invocation
Parameters: time - the date and time the method will be invoked Parameters: componentId - the unique name of a bean in the bean factory which implements command pattern DelayedInvocationCommand Parameters: opaqueContext - the key which the tool can use to uniquely identify some entity when invoked; i.e. | public void | deleteDelayedInvocation(String uuid) | public void | deleteDelayedInvocation(String componentId, String opaqueContext) Remove future scheduled invocations by the component and/or context,
can specify both items, just a component or just a context, or even leave both
as empty strings to remove all future invocations
Parameters: componentId - the unique name of a bean in the bean factory which implements command pattern DelayedInvocationCommand, may be empty string to match any component Parameters: opaqueContext - the key which the tool can use to uniquely identify some entity when invoked; i.e. | public DelayedInvocation[] | findDelayedInvocations(String componentId, String opaqueContext) Find future scheduled invocations by the component and/or context,
can specify both items, just a component or just a context, or even leave both
as empty strings to find all future invocations
Parameters: componentId - the unique name of a bean in the bean factory which implements command pattern DelayedInvocationCommand, may be empty string to match any component Parameters: opaqueContext - the key which the tool can use to uniquely identify some entity when invoked; i.e. |
createDelayedInvocation | public String createDelayedInvocation(Time time, String componentId, String opaqueContext)(Code) | | Creates a new delayed invocation and returns the unique id of the created invocation
Parameters: time - the date and time the method will be invoked Parameters: componentId - the unique name of a bean in the bean factory which implements command pattern DelayedInvocationCommand Parameters: opaqueContext - the key which the tool can use to uniquely identify some entity when invoked; i.e. the context unique id of a delayed invocation |
deleteDelayedInvocation | public void deleteDelayedInvocation(String uuid)(Code) | | Remove a future scheduled invocation by its unique id
Parameters: uuid - unique id of a delayed invocation |
deleteDelayedInvocation | public void deleteDelayedInvocation(String componentId, String opaqueContext)(Code) | | Remove future scheduled invocations by the component and/or context,
can specify both items, just a component or just a context, or even leave both
as empty strings to remove all future invocations
Parameters: componentId - the unique name of a bean in the bean factory which implements command pattern DelayedInvocationCommand, may be empty string to match any component Parameters: opaqueContext - the key which the tool can use to uniquely identify some entity when invoked; i.e. the context, may be empty string to match any context |
findDelayedInvocations | public DelayedInvocation[] findDelayedInvocations(String componentId, String opaqueContext)(Code) | | Find future scheduled invocations by the component and/or context,
can specify both items, just a component or just a context, or even leave both
as empty strings to find all future invocations
Parameters: componentId - the unique name of a bean in the bean factory which implements command pattern DelayedInvocationCommand, may be empty string to match any component Parameters: opaqueContext - the key which the tool can use to uniquely identify some entity when invoked; i.e. the context, may be empty string to match any context an array of DelayedInvocation objects representing all scheduledinvocations which match the inputs |
|
|