it.eng.spago.workflow.api
Interface IWorkflowProcess


public interface IWorkflowProcess

Author:
zoppello IWorkflow Process is tghe interface for the run time instances of the business process in the engine. It's very important not confuse IWorkflowProcess with IWorkflowDefinition objects. For a IWorkflowDefintion object we can have multiple instance of IWorkflowProcess Objects. This class has all the method to manage a run time process and it's context. Each instance of process has a map of variables called context, a runtime state a name and a description.

Method Summary
 void abort()
          This method abort the process execution before the end of execution.
 java.util.Map getContext()
          This method return the context of the process
 java.lang.String getDescription()
          This method return the process description
 java.lang.String getId()
          This metho eturn the identifier of the process in the engine
 java.lang.String getName()
          Get the name of the process
 java.lang.String getState()
          Get the current state of the process
 boolean isClosed()
          This method verify if a process is terminated
 void setContext(java.util.Map context)
          This method update the context ot the process
 void start()
          This method start the process.
 

Method Detail

start

void start()
           throws WorkflowEngineException
This method start the process. It's not enough to get an instance of the IWorkflowProcess to start the process, we must call this method to start the execution of the process

Throws:
WorkflowEngineException - if some errors occurs.

abort

void abort()
           throws WorkflowEngineException
This method abort the process execution before the end of execution.

Throws:
WorkflowEngineException - if some errors occurs.

getContext

java.util.Map getContext()
                         throws WorkflowEngineException
This method return the context of the process

Returns:
the context ( The map of the variable of the process )
Throws:
WorkflowEngineException - if some errors occurs

setContext

void setContext(java.util.Map context)
                throws WorkflowEngineException
This method update the context ot the process

Parameters:
context - the new context for this process
Throws:
WorkflowEngineException - if some errors occurs

getId

java.lang.String getId()
                       throws WorkflowEngineException
This metho eturn the identifier of the process in the engine

Returns:
the identifier of the process in the engines
Throws:
WorkflowEngineException

isClosed

boolean isClosed()
                 throws WorkflowEngineException
This method verify if a process is terminated

Returns:
true if the process is closed ( terminated )
Throws:
WorkflowEngineException - if some errors occurs

getState

java.lang.String getState()
                          throws WorkflowEngineException
Get the current state of the process

Returns:
the state of the project
Throws:
WorkflowEngineExceptionif - some errors occurs
WorkflowEngineException

getName

java.lang.String getName()
                         throws WorkflowEngineException
Get the name of the process

Returns:
The name of the process
Throws:
WorkflowEngineException - if some errors occurs

getDescription

java.lang.String getDescription()
                                throws WorkflowEngineException
This method return the process description

Returns:
the descritpion of the process
Throws:
WorkflowEngineException - if some errors occurs