org.imixs.workflow.faces.workitem

Class WorkflowController

java.lang.Object

org.imixs.workflow.faces.workitem.DocumentController

org.imixs.workflow.faces.workitem.WorkflowController

All Implemented Interfaces:

Serializable

public class WorkflowController
extends DocumentController

The WorkflowController can be used in JSF Applications to manage workflow processing on any workitem. The WorklfowController can be extended by a web module implementing a project specific behavior. The properties modelVersion and processID are used to control and create new workitem instances based on a model definition The workflowController bean is typically used in session scope.

Version:

2.0.0

Author:

rsoika

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
WorkflowController()

Method Summary

Modifier and Type	Method and Description
List<org.imixs.workflow.ItemCollection>	getEvents() This method returns a List of workflow events assigned to the corresponding '$taskid' and '$modelversion' of the current WorkItem.
ModelService	getModelService() returns an instance of the ModelService EJB
WorkflowService	getWorkflowService()
String	init(String action) This action method is used to initialize a new workitem with the inital values of the assigend workflow task.
String	process() This method processes the current workItem and returns an action result.
String	process(int id) This method processes the current workItem with the provided activityID.
String	process(int id, boolean resetWorkitem) This method processes the current workItem with the provided activityID.

Methods inherited from class org.imixs.workflow.faces.workitem.DocumentController

addMessage, create, create, delete, delete, getDefaultType, getDocumentService, getWorkitem, isNewWorkitem, load, load, reset, save, save, setDefaultType, setWorkitem

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

WorkflowController

public WorkflowController()

Method Detail

getModelService

public ModelService getModelService()

returns an instance of the ModelService EJB

Returns:

getWorkflowService

public WorkflowService getWorkflowService()

init

public String init(String action)
            throws org.imixs.workflow.exceptions.ModelException

This action method is used to initialize a new workitem with the inital values of the assigend workflow task. The method updates the Workflow attributes '$WriteAccess','$workflowgroup', '$workflowStatus', 'txtWorkflowImageURL' and 'txtWorkflowEditorid'.

Parameters:

action - - the action returned by this method

Returns:

- action

Throws:

org.imixs.workflow.exceptions.ModelException - is thrown in case not valid worklfow task if defined by the current model.

process

public String process()
               throws org.imixs.workflow.exceptions.PluginException,
                      org.imixs.workflow.exceptions.ModelException

This method processes the current workItem and returns an action result. The method expects that the current workItem provides a valid $ActiviytID. The method returns the value of the property 'action' if provided by the workflow model or a plug-in. The 'action' property is typically evaluated from the ResultPlugin. Alternatively the property can be provided by an application. If no 'action' property is provided the method returns null.

Returns:

the action result provided in the 'action' property or evaluated from the default property 'txtworkflowResultmessage' from the ActivityEntity

Throws:

org.imixs.workflow.exceptions.AccessDeniedException

org.imixs.workflow.exceptions.PluginException

org.imixs.workflow.exceptions.ModelException

process

public String process(int id,
                      boolean resetWorkitem)
               throws org.imixs.workflow.exceptions.PluginException,
                      org.imixs.workflow.exceptions.ModelException

This method processes the current workItem with the provided activityID. The method can be used as an actionListener.

Parameters:

id - - eventID to be processed

resetWorkitem - - boolean indicates if the workitem should be reset

Throws:

org.imixs.workflow.exceptions.PluginException

org.imixs.workflow.exceptions.ModelException

See Also:

process()

process

public String process(int id)
               throws org.imixs.workflow.exceptions.ModelException,
                      org.imixs.workflow.exceptions.PluginException

This method processes the current workItem with the provided activityID. The meethod can be used as an actionListener.

Parameters:

id - - activityID to be processed

Throws:

org.imixs.workflow.exceptions.PluginException

org.imixs.workflow.exceptions.ModelException

See Also:

process(), process(id,resetWorkitem)

getEvents

public List<org.imixs.workflow.ItemCollection> getEvents()

This method returns a List of workflow events assigned to the corresponding '$taskid' and '$modelversion' of the current WorkItem.

Returns: