Package com.day.cq.workflow
Interface WorkflowService
-
public interface WorkflowService
TheWorkflowService
is the main entry point for accessing the workflow engine. It defines life cycle methods for the workflow engine (eg tostart()
/stop()
it).It also provides functionality for getting a
per user based on the users JCR session and according credentials. Instances of theWorkflowSession
interface are used for all workflow operations like deploying a newWorkflowSession
WorkflowModel
or starting a newWorkflow
instance.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description Dictionary<String,Object>
getConfig()
Allows users of theWorkflowService
to retrieve settings and parameters related to theWorkflowService
implementation.WorkflowSession
getWorkflowSession(Session session)
Creates a new
based on the given JCR session.WorkflowSession
void
start()
The start method will initialize and start theWorkflowService
properly.void
stop()
This methods will shutdown theWorkflowService
properly.
-
-
-
Method Detail
-
start
void start() throws WorkflowException
The start method will initialize and start theWorkflowService
properly.- Throws:
WorkflowException
- Thrown in case that the initialization procedure fails.
-
stop
void stop()
This methods will shutdown theWorkflowService
properly. All active workflows will be suspended and all running processes will be terminated.
-
getWorkflowSession
WorkflowSession getWorkflowSession(Session session)
Creates a new
based on the given JCR session. The credentials of the JCR session define what the user can access and which operations he is allowed to do.WorkflowSession
- Parameters:
session
- The users JCR session to be used for initializing the
.WorkflowSession
- Returns:
- A new instance of the
based on the given JCR session.WorkflowSession
-
getConfig
Dictionary<String,Object> getConfig()
Allows users of theWorkflowService
to retrieve settings and parameters related to theWorkflowService
implementation. In common these are provided by the environment (eg. a OSGi compliant container or a servlet engine.- Returns:
- Returns the map of configuration parameters for the
WorkflowService
.
-
-