org.imixs.workflow.jee.faces.workitem

Class WorkflowController

java.lang.Object

org.imixs.workflow.jee.faces.workitem.DataController

org.imixs.workflow.jee.faces.workitem.WorkflowController

All Implemented Interfaces:

Serializable

public class WorkflowController
extends DataController

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:

0.0.2

Author:

rsoika

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
WorkflowController()

Method Summary

Modifier and Type	Method and Description
String	getAction() returns the last computed workflow resultmessage.
List<org.imixs.workflow.ItemCollection>	getActivities() returns a arrayList of Activities to the corresponding processiD 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.
boolean	isNewWorkitem() Returns true if the current workItem was processed before by the workflowService.
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.
String	save(String action) This method overwrite the default behavior and processes the current workItem.
void	setWorkitem(org.imixs.workflow.ItemCollection aworkitem) Updates the current workItem and reset the activityList.

Methods inherited from class org.imixs.workflow.jee.faces.workitem.DataController

addMessage, create, delete, delete, deleteChilds, getEntityService, getID, getType, getWorkitem, load, load, reset, reset, save, setType

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()

setWorkitem

public void setWorkitem(org.imixs.workflow.ItemCollection aworkitem)

Updates the current workItem and reset the activityList.

Overrides:

setWorkitem in class DataController

Parameters:

aworkitem - - new reference or null to clear the current workItem.

init

public String init(String action)

This action method is used to initialize a new workitem. There for the method loads the initial ProcessEntity and updates the Workflow attributes WorfklowGroup and EditorId. if the new workItem has no $modelversion the method set a default model version (computed by the latest version and the first processEntiy).

Parameters:

action - - the action returned by this method

Returns:

- action

Throws:

org.imixs.workflow.exceptions.ModelException

process

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

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 evaluates the default property 'txtworkflowResultmessage' from the model as an action result. The method resets the current ActivityList after the workitem was processed.

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.ProcessingErrorException

process

public String process(int id)
               throws org.imixs.workflow.exceptions.AccessDeniedException,
                      org.imixs.workflow.exceptions.ProcessingErrorException,
                      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.AccessDeniedException

org.imixs.workflow.exceptions.ProcessingErrorException

See Also:

process(), process(id,resetWorkitem)

process

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

This method processes the current workItem with the provided activityID. The method can be used as an actionListener. If the Boolean 'reset' is true then the controller will be reset after process.

Parameters:

id - - activityID to be processed

resetWorkitem - - boolean indicates if the workitem should be reset

Throws:

org.imixs.workflow.exceptions.PluginException

org.imixs.workflow.exceptions.AccessDeniedException

org.imixs.workflow.exceptions.ProcessingErrorException

See Also:

process()

save

public String save(String action)
            throws org.imixs.workflow.exceptions.AccessDeniedException

This method overwrite the default behavior and processes the current workItem.

Overrides:

save in class DataController

Parameters:

action - - defines the action result

Returns:

action result

Throws:

org.imixs.workflow.exceptions.AccessDeniedException - - if user has insufficient access rights.

getAction

public String getAction()

returns the last computed workflow resultmessage. The property 'txtworkflowresultmessage' is computed by the ResultPlugin. If no txtworkflowresultmessage is found an empty string will be returned

Returns:

- the action result

getActivities

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

returns a arrayList of Activities to the corresponding processiD of the current WorkItem. The Method returns the activities corresponding to the workItems modelVersionID. The list of computed activities is cashed until a new workItem was set or the current workItem was processed.

Returns:

isNewWorkitem

public boolean isNewWorkitem()

Returns true if the current workItem was processed before by the workflowService. This is identified by the property 'numLastActivityID' which is computed by the WorkflowKernel.

Overrides:

isNewWorkitem in class DataController

Returns:

true if the current workItem was already processed by the WorkflowKernel