com.sssw.wf.client
Interface EbiQueueDelegate

public interface EbiQueueDelegate

The delegate interface needed for access to the work queue

Field Summary

static int	QUEUE_STATUS_RUNNING Deprecated. process lifecycle management has been concentrated in the workflow engine
static int	QUEUE_STATUS_SHUTDOWN Deprecated. process lifecycle management has been concentrated in the workflow engine
static int	QUEUE_STATUS_SUSPENDED Deprecated. process lifecycle management has been concentrated in the workflow engine

Method Summary

void	forward(EbiWorkitemDelegate delegate) Forwards a workitem to the next activity.
void	forward(EbiWorkitemDelegate delegate, EbiContext context) Forwards a workitem to the next activity.
void	forward(String workitemId) Forwards a workitem to the next activity.
EbiWorkitemDelegate	getNextWorkitem(EbiContext context) Gets the next workitem.
EbiWorkitemDelegate	getNextWorkitem(String activity) Deprecated. This method is applicable only for Director 4.x java activities migrated to 5.0. Use getNextWorkitem( Ebicontext ) as the alternative for all newly created java activities starting in 5.0 and later.
int	getQueueStatus() Deprecated. process lifecycle management has been concentrated in the workflow engine, queue state is part of the engine state
EbiWorkitemDelegate	getWorkitem(String workitemId) Gets a workitem by workitem id.
EbiWorkitemDelegate	getWorkitem(String workitemId, EbiContext context) Gets a workitem by workitem id.
String[]	getWorkitemIds(EbiContext context) Return an array of workitem identifiers for workitems in the work queue.
Document	getWorklist(EbiContext context) Deprecated. use String[] getWorkitemIds(EbiContext) instead.
Document	getWorklist(EbiContext context, boolean excludeClaimedWorkitems, boolean excludedUnclaimedWorkitems) Deprecated. use String[] getWorkitemIds(EbiContext) instead.
Document	getWorklist(String activity) Deprecated. use String[] getWorkitemIds(EbiContext) instead.
Document	getWorklist(String[] addressee, String name, Integer priority, boolean ignoreSuspendedActivities) Deprecated. use String[] getWorkitemIds(EbiContext) instead.
void	reassignWorkitem(String workitemId, String newAddressee, EbiContext context) Reassign a workitem to a new user.
void	removeWorkitem(String workitemId, boolean terminateActivity) Removes a workitem from the queue.
void	setQueueStatus(int status) Deprecated. process lifecycle management has been concentrated in the workflow engine, queue state is part of the engine state
void	shutdownQueue() Deprecated. process lifecycle management has been concentrated in the workflow engine, queue state is part of the engine state
void	startQueue() Deprecated. process lifecycle management has been concentrated in the workflow engine, queue state is part of the engine state
void	suspendQueue() Deprecated. process lifecycle management has been concentrated in the workflow engine, queue state is part of the engine state

Field Detail

QUEUE_STATUS_RUNNING

public static final int QUEUE_STATUS_RUNNING

Deprecated. process lifecycle management has been concentrated in the workflow engine

Constant to be used when setting queue status to running.

QUEUE_STATUS_SUSPENDED

public static final int QUEUE_STATUS_SUSPENDED

Deprecated. process lifecycle management has been concentrated in the workflow engine

Constant to be used when setting queue status to suspended.

QUEUE_STATUS_SHUTDOWN

public static final int QUEUE_STATUS_SHUTDOWN

Deprecated. process lifecycle management has been concentrated in the workflow engine

Constant to be used when setting queue status to shudown.

Method Detail

getWorkitem

public EbiWorkitemDelegate getWorkitem(String workitemId)
                                throws com.sssw.wf.client.EboWorkitemException

Gets a workitem by workitem id.

Parameters:

workitemId - The id of the workitem desired.

Returns:

Returns an EbiWorkitemDelegate of the workitem retrieved.

Throws:

com.sssw.wf.client.EboWorkitemException - Throws an EboWorkitemException if the workitem cannot be retrieved.

getWorkitem

public EbiWorkitemDelegate getWorkitem(String workitemId,
                                       EbiContext context)
                                throws com.sssw.wf.client.EboWorkitemException,
                                       com.sssw.wf.client.EboQueueException

Gets a workitem by workitem id. Need a context for security purposes.

Parameters:

workitemId - The id of the workitem desired.

context - The context for the current activity/user.

Returns:

an EbiWorkitemDelegate of the workitem retrieved.

Throws:

com.sssw.wf.client.EboWorkitemException - Throws an EboWorkitemException if the workitem cannot be retrieved.

com.sssw.wf.client.EboQueueException -

getNextWorkitem

public EbiWorkitemDelegate getNextWorkitem(EbiContext context)

Gets the next workitem. Claims this workitem for the user or role in the context.

Parameters:

context - The context of the current user/activity.

Returns:

an EbiWorkitemDelegate of the workitem retrieved.

getNextWorkitem

public EbiWorkitemDelegate getNextWorkitem(String activity)

Deprecated. This method is applicable only for Director 4.x java activities migrated to 5.0. Use getNextWorkitem( Ebicontext ) as the alternative for all newly created java activities starting in 5.0 and later.

Gets the next workitem for a 'java' activity.

Parameters:

activity - The current activity class name. To get the class name of the activity, call this.getClass().getName().

Returns:

an EbiWorkitemDelegate of the next workitem for this activity

forward

public void forward(String workitemId)
             throws com.sssw.wf.client.EboWorkitemException

Forwards a workitem to the next activity. This signifies that an activity is complete and the process should continue.

Parameters:

workitemId - The id of the workitem to forward.

Throws:

com.sssw.wf.client.EboWorkitemException - Throws an exception if the workitem cannot be determined from the id.

forward

public void forward(EbiWorkitemDelegate delegate)
             throws com.sssw.wf.client.EboQueueException

Forwards a workitem to the next activity. This signifies that an activity is complete and the process should continue. @deprecate (EbiWorkitemDelegate delegate, EbiContext context)

Parameters:

delegate - The workitem to forward.

forward

public void forward(EbiWorkitemDelegate delegate,
                    EbiContext context)
             throws com.sssw.wf.client.EboQueueException

Forwards a workitem to the next activity. This signifies that an activity is complete and the process should continue.

Parameters:

delegate - The workitem to forward.

context - The requestor's context.

getWorklist

public Document getWorklist(String activity)
                     throws com.sssw.wf.client.EboWorkitemException

Deprecated. use String[] getWorkitemIds(EbiContext) instead.

Gets a worklist for an 'automatic' activity that implements EbiActivity. This method is not thread safe. The caller must ensure that only one thread is calling this method at a time.

Parameters:

activity - classname of the user implementation of EbiActivity.

Returns:

A document that contains the worklist. It adheres to workflow-worklist_3_0.dtd.

Throws:

com.sssw.wf.client.EboWorkitemException - Throws an EboWorkitemException if the worklist cannot get generated.

getWorklist

public Document getWorklist(EbiContext context)
                     throws com.sssw.wf.client.EboWorkitemException

Deprecated. use String[] getWorkitemIds(EbiContext) instead.

Gets a queued workitem list for a 'non-automatic' activity. Retrieves both claimed and unclaimed queued workitems. This method is not thread safe. The caller must ensure that only one thread is calling this method at a time.

Parameters:

context - The context for the current user/activity.

Returns:

A document that contains the worklist. It adheres to workflow-worklist_3_0.dtd.

Throws:

com.sssw.wf.client.EboWorkitemException - throws an EboWorkitemException if the worklist cannot be generated.

getWorklist

public Document getWorklist(EbiContext context,
                            boolean excludeClaimedWorkitems,
                            boolean excludedUnclaimedWorkitems)
                     throws com.sssw.wf.client.EboWorkitemException

Deprecated. use String[] getWorkitemIds(EbiContext) instead.

Gets a queued workitem list for the user or role in the context, optionally excluding all the claimed workitems or unclaimed workitems. This method is not thread safe. The caller must ensure that only one thread is calling this method at a time.

Parameters:

context - The context for the current user/activity.

excludeClaimedWorkitems - If true, will get only unclaimed workitems.

excludeUnclaimedWorkitems - If true, will get only claimed workitems.

Returns:

A document that contains the worklist. It adheres to workflow-worklist_3_0.dtd.

Throws:

com.sssw.wf.client.EboWorkitemException -

getWorklist

public Document getWorklist(String[] addressee,
                            String name,
                            Integer priority,
                            boolean ignoreSuspendedActivities)
                     throws com.sssw.wf.client.EboWorkitemException

Deprecated. use String[] getWorkitemIds(EbiContext) instead.

Gets a worklist based on customized parameters. This is primarily used for administration purposes. This method is not thread safe. The caller must ensure that only one thread is calling this method at a time.

Parameters:

addressee - An array of addressees to lookup. Optional.

name - The name of the workitem. Optional.

priority - The priority of the workitem to lookup. Optional.

ignoreSuspendedActivities - Whether or not to include suspended activities in the result set.

Returns:

A document that contains the worklist. It adheres to workflow-worklist_3_0.dtd.

Throws:

com.sssw.wf.client.EboWorkitemException - Throws an EboWorkitemException if the worklist cannot be created.

getWorkitemIds

public String[] getWorkitemIds(EbiContext context)
                        throws com.sssw.wf.client.EboQueueException

Return an array of workitem identifiers for workitems in the work queue. This method is thread-safe, it can be called from multiple cucnrrent threads. The list of identifier reflect the contents of work queue at the time of this method's invocation. It is not guaranteed that workitem with identifier returned from this mehod will be in the queue at subsequent invocations. In order to ensure that workitem is being accessed in exclusive mode it first must be claimed.

Parameters:

context - caller context

Returns:

String[] workitem identifiers

Throws:

com.sssw.wf.client.EboQueueException - if workitem array cannot be obtained

setQueueStatus

public void setQueueStatus(int status)
                    throws com.sssw.wf.client.EboQueueException

Deprecated. process lifecycle management has been concentrated in the workflow engine, queue state is part of the engine state

This method is no-op.

startQueue

public void startQueue()
                throws com.sssw.wf.client.EboQueueException

Deprecated. process lifecycle management has been concentrated in the workflow engine, queue state is part of the engine state

This method is no-op.

suspendQueue

public void suspendQueue()
                  throws com.sssw.wf.client.EboQueueException

Deprecated. process lifecycle management has been concentrated in the workflow engine, queue state is part of the engine state

This method is no-op.

shutdownQueue

public void shutdownQueue()
                   throws com.sssw.wf.client.EboQueueException

Deprecated. process lifecycle management has been concentrated in the workflow engine, queue state is part of the engine state

This method is no-op.

getQueueStatus

public int getQueueStatus()
                   throws com.sssw.wf.client.EboQueueException

Deprecated. process lifecycle management has been concentrated in the workflow engine, queue state is part of the engine state

Return QUEUE_STATUS_RUNNING

removeWorkitem

public void removeWorkitem(String workitemId,
                           boolean terminateActivity)
                    throws com.sssw.wf.client.EboQueueException

Removes a workitem from the queue. Primarily for administrative purposes.

Parameters:

workitemId - The workitem id to be removed.

terminateActivity - If the activity is 'automatic', the terminate method will be fired.

Throws:

com.sssw.wf.client.EboQueueException - Throws an EboQueueException if the workitem cannot be determined or cannot be stopped.

reassignWorkitem

public void reassignWorkitem(String workitemId,
                             String newAddressee,
                             EbiContext context)
                      throws com.sssw.wf.client.EboQueueException

Reassign a workitem to a new user. Primarily for administrative purposes.

Parameters:

workitemId - The workitem id to be removed.

newAddressee - The new addresse who the worktiem will be assigned to.

EbiContext - The context for the current queue.

Throws:

com.sssw.wf.client.EboQueueException - Throws an EboQueueException if the workitem cannot be determined or cannot be stopped.