com.sssw.wf.client
Interface EbiEngineAdminDelegate

All Superinterfaces:

EbiDelegate

public interface EbiEngineAdminDelegate

extends EbiDelegate

Used to perform Workflow Admin tasks from the client

Fields inherited from interface com.sssw.fw.api.EbiDelegate

SERVICE_LOCAL, SERVICE_REMOTE

Method Summary

String	getEngineId() Returns the Workflow Engine ID
Document	getFinishedProcesses() Gets the list of finished workflow processes
Document	getFinishedProcesses(String processId) Gets a finished workflow process
Document	getRunningProcesses() Gets the list of running workflow processes
Document	getRunningProcesses(String processId) Gets a running workflow process
Document	getSuspendedProcesses() Gets the list of suspended workflow processes
Document	getSuspendedProcesses(String processId) Gets a suspended workflow process
void	restartEngine(String engineId, EbiContext context) Restarts the Workflow Engine
void	resumeActivity(String processId, String runNumber, String activityId, EbiContext context) Resumes a workflow activity
void	resumeProcess(String processId, String runNumber, EbiContext context) Resumes a workflow process
void	shutdownEngine(String engineId, EbiContext context) Shuts down the Workflow Engine
void	startEngine(String engineId, EbiContext context) Starts the Workflow Engine
void	suspendActivity(String processId, String runNumber, String activityId, EbiContext context) Suspends a workflow activity
void	suspendEngine(String engineId, EbiContext context) Suspends the Workflow Engine
void	suspendProcess(String processId, String runNumber, EbiContext context) Suspends a workflow process
void	terminateProcess(String processId, String runNumber, EbiContext context) Terminates a running workflow process

Methods implemented from interface com.sssw.fw.api.EbiDelegate

getName

Method Detail

getRunningProcesses

public Document getRunningProcesses()
                             throws com.sssw.wf.exception.EboEngineAdminException

Gets the list of running workflow processes

Returns:

list of running workflow processes (org.w3c.dom.Document)

Throws:

throws - com.sssw.wf.exception.EboEngineAdminException

getSuspendedProcesses

public Document getSuspendedProcesses()
                               throws com.sssw.wf.exception.EboEngineAdminException

Gets the list of suspended workflow processes

Returns:

list of suspended workflow processes (org.w3c.dom.Document)

Throws:

throws - com.sssw.wf.exception.EboEngineAdminException

getRunningProcesses

public Document getRunningProcesses(String processId)
                             throws com.sssw.wf.exception.EboEngineAdminException

Gets a running workflow process

Parameters:

processId - the String id for the running process being requested

Returns:

the running workflow process (org.w3c.dom.Document)

Throws:

throws - com.sssw.wf.exception.EboEngineAdminException

getSuspendedProcesses

public Document getSuspendedProcesses(String processId)
                               throws com.sssw.wf.exception.EboEngineAdminException

Gets a suspended workflow process

Parameters:

processId - the String id for the suspended process being requested

Returns:

the suspended workflow process (org.w3c.dom.Document)

Throws:

throws - com.sssw.wf.exception.EboEngineAdminException

getFinishedProcesses

public Document getFinishedProcesses()
                              throws com.sssw.wf.exception.EboEngineAdminException

Gets the list of finished workflow processes

Returns:

list of finished workflow processes (org.w3c.dom.Document)

Throws:

throws - com.sssw.wf.exception.EboEngineAdminException

getFinishedProcesses

public Document getFinishedProcesses(String processId)
                              throws com.sssw.wf.exception.EboEngineAdminException

Gets a finished workflow process

Parameters:

processId - the String id for the finished process being requested

Returns:

the finished workflow process (org.w3c.dom.Document)

Throws:

throws - com.sssw.wf.exception.EboEngineAdminException

suspendProcess

public void suspendProcess(String processId,
                           String runNumber,
                           EbiContext context)
                    throws com.sssw.wf.exception.EboEngineAdminException

Suspends a workflow process

Parameters:

processId - the String id for the process to be suspended

runNumber - the String run number for identifying the process instance to be suspended

Throws:

throws - com.sssw.wf.exception.EboEngineAdminException

resumeProcess

public void resumeProcess(String processId,
                          String runNumber,
                          EbiContext context)
                   throws com.sssw.wf.exception.EboEngineAdminException

Resumes a workflow process

Parameters:

processId - the String id for the process to be resumed

runNumber - the String run number for identifying the process instance to be resumed

Throws:

throws - com.sssw.wf.exception.EboEngineAdminException

suspendActivity

public void suspendActivity(String processId,
                            String runNumber,
                            String activityId,
                            EbiContext context)
                     throws com.sssw.wf.exception.EboEngineAdminException

Suspends a workflow activity

Parameters:

processId - the String id for the process

runNumber - the String run number for identifying the process instance

activityId - the String id for the activity to be suspended

Throws:

throws - com.sssw.wf.exception.EboEngineAdminException

resumeActivity

public void resumeActivity(String processId,
                           String runNumber,
                           String activityId,
                           EbiContext context)
                    throws com.sssw.wf.exception.EboEngineAdminException

Resumes a workflow activity

Parameters:

processId - the String id for the process

runNumber - the String run number for identifying the process instance

activityId - the String id for the activity to be resumed

Throws:

throws - com.sssw.wf.exception.EboEngineAdminException

terminateProcess

public void terminateProcess(String processId,
                             String runNumber,
                             EbiContext context)
                      throws com.sssw.wf.exception.EboEngineAdminException

Terminates a running workflow process

Parameters:

processId - the String id for the process

runNumber - the String run number for identifying the process instance

Throws:

throws - com.sssw.wf.exception.EboEngineAdminException

getEngineId

public String getEngineId()
                   throws com.sssw.wf.exception.EboEngineAdminException

Returns the Workflow Engine ID

Returns:

the String representing the Engine ID

Throws:

throws - com.sssw.wf.exception.EboEngineAdminException

restartEngine

public void restartEngine(String engineId,
                          EbiContext context)
                   throws com.sssw.wf.exception.EboEngineAdminException

Restarts the Workflow Engine

Parameters:

engineId - the String representing the Engine ID

Throws:

throws - com.sssw.wf.exception.EboEngineAdminException

startEngine

public void startEngine(String engineId,
                        EbiContext context)
                 throws com.sssw.wf.exception.EboEngineAdminException

Starts the Workflow Engine

Parameters:

engineId - the String representing the Engine ID

context - the workflow context (com.sssw.wf.api.EbiContext)

Throws:

throws - com.sssw.wf.exception.EboEngineAdminException

suspendEngine

public void suspendEngine(String engineId,
                          EbiContext context)
                   throws com.sssw.wf.exception.EboEngineAdminException

Suspends the Workflow Engine

Parameters:

engineId - the String representing the Engine ID

context - the workflow context (com.sssw.wf.api.EbiContext)

Throws:

throws - com.sssw.wf.exception.EboEngineAdminException

shutdownEngine

public void shutdownEngine(String engineId,
                           EbiContext context)
                    throws com.sssw.wf.exception.EboEngineAdminException

Shuts down the Workflow Engine

Parameters:

engineId - the String representing the Engine ID

context - the workflow context (com.sssw.wf.api.EbiContext)

Throws:

throws - com.sssw.wf.exception.EboEngineAdminException