org.imixs.workflow.jee.ejb
Interface WorkflowScheduler

All Known Subinterfaces:

WorkflowSchedulerRemote

public interface WorkflowScheduler

This Interface represents a schedueld Workflow Service. It is used by the WorkflowSchedulerBean which implements a timer service to schedule workflow processing

Author:

rsoika

Method Summary

void	cancelScheduleWorkflow(java.lang.String id) cancles a running timer instance.
java.util.Collection<org.imixs.workflow.ItemCollection>	findAllTimerDescriptions() returns a list of all Timer Descriptions loaded by this Instance.
org.imixs.workflow.ItemCollection	findTimerDescription(java.lang.String id) this method returns a Itemcollection with the TimerDescirpiton for the specific timer object.
void	scheduleWorkflow(org.imixs.workflow.ItemCollection timerdescription) schedules a new Workflow Service.

Method Detail

scheduleWorkflow

void scheduleWorkflow(org.imixs.workflow.ItemCollection timerdescription)
                      throws java.lang.Exception

schedules a new Workflow Service. The method expects an ItemCollection (timerdescription) with the following informations: datstart - Date Object datstop - Date Object numInterval - Integer Object (interval in seconds) id - String - unique identifier for the schedule Service. This param should contain the EJB name as only one scheduled Workflow should run inside a single WorkflowInstance. If a timer with the id is already running the method stops this timer object first and reschedules the timer .

Throws:

java.lang.Exception

cancelScheduleWorkflow

void cancelScheduleWorkflow(java.lang.String id)
                            throws java.lang.Exception

cancles a running timer instance. After cancel a timer the corresponding timerDescripton (ItemCollection) is no longer valid

Throws:

java.lang.Exception

findTimerDescription

org.imixs.workflow.ItemCollection findTimerDescription(java.lang.String id)
                                                       throws java.lang.Exception

this method returns a Itemcollection with the TimerDescirpiton for the specific timer object.

Parameters:

id - identifies the timer object

Returns:

ItemCollection containing the TimerDescription

Throws:

java.lang.Exception

findAllTimerDescriptions

java.util.Collection<org.imixs.workflow.ItemCollection> findAllTimerDescriptions()
                                                                                 throws java.lang.Exception

returns a list of all Timer Descriptions loaded by this Instance.

Returns:

Throws:

java.lang.Exception