org.imixs.workflow.engine

Class WorkflowService

java.lang.Object

org.imixs.workflow.engine.WorkflowService

All Implemented Interfaces:

WorkflowContext, WorkflowManager

@DeclareRoles(value={"org.imixs.ACCESSLEVEL.NOACCESS","org.imixs.ACCESSLEVEL.READERACCESS","org.imixs.ACCESSLEVEL.AUTHORACCESS","org.imixs.ACCESSLEVEL.EDITORACCESS","org.imixs.ACCESSLEVEL.MANAGERACCESS"})
 @RolesAllowed(value={"org.imixs.ACCESSLEVEL.NOACCESS","org.imixs.ACCESSLEVEL.READERACCESS","org.imixs.ACCESSLEVEL.AUTHORACCESS","org.imixs.ACCESSLEVEL.EDITORACCESS","org.imixs.ACCESSLEVEL.MANAGERACCESS"})
public class WorkflowService
extends Object
implements WorkflowManager, WorkflowContext

The WorkflowService is the Java EE Implementation for the Imixs Workflow Core API. This interface acts as a service facade and supports basic methods to create, process and access workitems. The Interface extends the core api interface org.imixs.workflow.WorkflowManager with getter methods to fetch collections of workitems.

Author:

rsoika

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_TYPE
static String	INVALID_ITEM_FORMAT
static String	INVALID_ITEMVALUE_FORMAT
protected javax.enterprise.event.Event<ProcessingEvent>	processingEvents
static int	SORT_ORDER_CREATED_ASC
static int	SORT_ORDER_CREATED_DESC
static int	SORT_ORDER_MODIFIED_ASC
static int	SORT_ORDER_MODIFIED_DESC
protected javax.enterprise.event.Event<TextEvent>	textEvents
static String	UNIQUEIDREF

Constructor Summary

Constructors

Constructor and Description
WorkflowService()

Method Summary

Modifier and Type	Method and Description
String	adaptText(String text, ItemCollection documentContext) The method adaptText can be called to replace predefined xml tags included in a text with custom values.
List<String>	adaptTextList(String text, ItemCollection documentContext) The method adaptTextList can be called to replace a text with custom values.
ItemCollection	evalNextTask(ItemCollection documentContext, ItemCollection event) This method evaluates the next task based on a Model Event element.
ItemCollection	evalWorkflowResult(ItemCollection activityEntity, ItemCollection documentContext) The method evaluates the WorkflowResult of a BPMN event and resolves embedded ItemValues
ItemCollection	evalWorkflowResult(ItemCollection event, ItemCollection documentContext, boolean resolveItemValues) The method evaluates the WorkflowResult for a given BPMN event and returns a ItemColleciton containing all item definitions.
DocumentService	getDocumentService() Returns an instance of the DocumentService EJB.
List<ItemCollection>	getEvents(ItemCollection workitem) This returns a list of workflow events assigned to a given workitem.
ModelManager	getModelManager() This Method returns the modelManager Instance.
PropertyService	getPropertyService() Returns an instance of the PropertyService EJB.
ReportService	getReportService() Returns an instance of the ReportService EJB.
javax.ejb.SessionContext	getSessionContext() Returns an instance of the EJB session context.
String	getUserName() Obtain the java.security.Principal that identifies the caller and returns the name of this principal.
List<String>	getUserNameList() This method returns a list of user names, roles and application groups the caller belongs to.
ItemCollection	getWorkItem(String uniqueid) This method loads a Workitem with the corresponding uniqueid.
List<ItemCollection>	getWorkListByAuthor(String name, String type, int pageSize, int pageIndex, String sortBy, boolean sortReverse) Returns a collection of workItems belonging to a specified username.
List<ItemCollection>	getWorkListByCreator(String name, String type, int pageSize, int pageIndex, String sortBy, boolean sortReverse) Returns a collection of workitems created by a specified user ($Creator).
List<ItemCollection>	getWorkListByGroup(String name, String type, int pageSize, int pageIndex, String sortBy, boolean sortReverse) Returns a list of workitems filtered by the field $workflowgroup the method supports still also the deprecated field "txtworkflowgroup"
List<ItemCollection>	getWorkListByOwner(String name, String type, int pageSize, int pageIndex, String sortBy, boolean sortReverse) Returns a collection of workitems containing a namOwner property belonging to a specified username.
List<ItemCollection>	getWorkListByProcessID(int aid, String type, int pageSize, int pageIndex, String sortBy, boolean sortReverse) Returns a collection of workitems belonging to a specified $taskID defined by the workflow model.
List<ItemCollection>	getWorkListByRef(String aref) Returns a collection of all workitems belonging to a specified workitem identified by the attribute $UniqueIDRef.
List<ItemCollection>	getWorkListByRef(String aref, String type, int pageSize, int pageIndex, String sortBy, boolean sortReverse) Returns a collection of workitems belonging to a specified workitem identified by the attribute $UniqueIDRef.
List<ItemCollection>	getWorkListByWriteAccess(String type, int pageSize, int pageIndex, String sortBy, boolean sortReverse) Returns a collection of workitems where the current user has a writeAccess.
boolean	isUserInRole(String rolename) Test if the caller has a given security role.
ItemCollection	processWorkItem(ItemCollection workitem) This method processes a workItem by the WorkflowKernel and saves the workitem after the processing was finished successful.
ItemCollection	processWorkItem(ItemCollection workitem, int eventID) This method processes a workItem based on a given event.
ItemCollection	processWorkItem(ItemCollection workitem, ItemCollection event) This method processes a workItem based on a given event.
void	removeWorkItem(ItemCollection aworkitem)

Methods inherited from class java.lang.Object

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

Field Detail

UNIQUEIDREF

public static final String UNIQUEIDREF

See Also:

Constant Field Values

DEFAULT_TYPE

public static final String DEFAULT_TYPE

See Also:

Constant Field Values

SORT_ORDER_CREATED_DESC

public static final int SORT_ORDER_CREATED_DESC

See Also:

Constant Field Values

SORT_ORDER_CREATED_ASC

public static final int SORT_ORDER_CREATED_ASC

See Also:

Constant Field Values

SORT_ORDER_MODIFIED_DESC

public static final int SORT_ORDER_MODIFIED_DESC

See Also:

Constant Field Values

SORT_ORDER_MODIFIED_ASC

public static final int SORT_ORDER_MODIFIED_ASC

See Also:

Constant Field Values

INVALID_ITEMVALUE_FORMAT

public static final String INVALID_ITEMVALUE_FORMAT

See Also:

Constant Field Values

INVALID_ITEM_FORMAT

public static final String INVALID_ITEM_FORMAT

See Also:

Constant Field Values

processingEvents

@Inject
protected javax.enterprise.event.Event<ProcessingEvent> processingEvents

textEvents

@Inject
protected javax.enterprise.event.Event<TextEvent> textEvents

Constructor Detail

WorkflowService

public WorkflowService()

Method Detail

getWorkItem

public ItemCollection getWorkItem(String uniqueid)

This method loads a Workitem with the corresponding uniqueid.

Specified by:

getWorkItem in interface WorkflowManager

getWorkListByOwner

public List<ItemCollection> getWorkListByOwner(String name,
                                               String type,
                                               int pageSize,
                                               int pageIndex,
                                               String sortBy,
                                               boolean sortReverse)

Returns a collection of workitems containing a namOwner property belonging to a specified username. The namOwner property can be controlled by the plug-in org.imixs.workflow.plugins.OwnerPlugin

Parameters:

name - = username for property namOwner - if null current username will be used

pageSize - = optional page count (default 20)

pageIndex - = optional start position

type - = defines the type property of the workitems to be returnd. can be null

sortBy - -optional field to sort the result

sortReverse - - optional sort direction

Returns:

List of workitems

getWorkListByAuthor

public List<ItemCollection> getWorkListByAuthor(String name,
                                                String type,
                                                int pageSize,
                                                int pageIndex,
                                                String sortBy,
                                                boolean sortReverse)

Returns a collection of workItems belonging to a specified username. The name is a username or role contained in the $WriteAccess attribute of the workItem. The method returns only workitems the call has sufficient read access for.

Parameters:

name - = username or role contained in $writeAccess - if null current username will be used

pageSize - = optional page count (default 20)

pageIndex - = optional start position

type - = defines the type property of the workitems to be returnd. can be null

sortBy - -optional field to sort the result

sortReverse - - optional sort direction

Returns:

List of workitems

getWorkListByCreator

public List<ItemCollection> getWorkListByCreator(String name,
                                                 String type,
                                                 int pageSize,
                                                 int pageIndex,
                                                 String sortBy,
                                                 boolean sortReverse)

Returns a collection of workitems created by a specified user ($Creator). The behaivor is simmilar to the method getWorkList.

Parameters:

name - = username for property $Creator - if null current username will be used

pageSize - = optional page count (default 20)

pageIndex - = optional start position

type - = defines the type property of the workitems to be returnd. can be null

sortBy - -optional field to sort the result

sortReverse - - optional sort direction

Returns:

List of workitems

getWorkListByWriteAccess

public List<ItemCollection> getWorkListByWriteAccess(String type,
                                                     int pageSize,
                                                     int pageIndex,
                                                     String sortBy,
                                                     boolean sortReverse)

Returns a collection of workitems where the current user has a writeAccess. This means the either the username or one of the userroles is contained in the $writeaccess property

Parameters:

pageSize - = optional page count (default 20)

pageIndex - = optional start position

type - = defines the type property of the workitems to be returnd. can be null

sortorder - = defines sortorder (SORT_ORDER_CREATED_DESC = 0 SORT_ORDER_CREATED_ASC = 1 SORT_ORDER_MODIFIED_DESC = 2 SORT_ORDER_MODIFIED_ASC = 3)

sortBy - -optional field to sort the result

sortReverse - - optional sort direction

Returns:

List of workitems

getWorkListByGroup

public List<ItemCollection> getWorkListByGroup(String name,
                                               String type,
                                               int pageSize,
                                               int pageIndex,
                                               String sortBy,
                                               boolean sortReverse)

Returns a list of workitems filtered by the field $workflowgroup the method supports still also the deprecated field "txtworkflowgroup"

Parameters:

name -

type -

pageSize - = optional page count (default 20)

pageIndex - = optional start position

sortBy - -optional field to sort the result

sortReverse - - optional sort direction

Returns:

getWorkListByProcessID

public List<ItemCollection> getWorkListByProcessID(int aid,
                                                   String type,
                                                   int pageSize,
                                                   int pageIndex,
                                                   String sortBy,
                                                   boolean sortReverse)

Returns a collection of workitems belonging to a specified $taskID defined by the workflow model. The behaivor is simmilar to the method getWorkList.

Parameters:

aID - = $taskID for the workitems to be returned.

pageSize - = optional page count (default 20)

pageIndex - = optional start position

type - = defines the type property of the workitems to be returnd. can be null

sortBy - -optional field to sort the result

sortReverse - - optional sort direction

Returns:

List of workitems

getWorkListByRef

public List<ItemCollection> getWorkListByRef(String aref,
                                             String type,
                                             int pageSize,
                                             int pageIndex,
                                             String sortBy,
                                             boolean sortReverse)

Returns a collection of workitems belonging to a specified workitem identified by the attribute $UniqueIDRef. The behaivor of this Mehtod is simmilar to the method getWorkList.

Parameters:

aref - A unique reference to another workitem inside a database *

pageSize - = optional page count (default 20)

pageIndex - = optional start position

type - = defines the type property of the workitems to be returnd. can be null

sortBy - -optional field to sort the result

sortReverse - - optional sort direction

Returns:

List of workitems

getWorkListByRef

public List<ItemCollection> getWorkListByRef(String aref)

Returns a collection of all workitems belonging to a specified workitem identified by the attribute $UniqueIDRef.

Returns:

List of workitems

getEvents

public List<ItemCollection> getEvents(ItemCollection workitem)
                               throws ModelException

This returns a list of workflow events assigned to a given workitem. The method evaluates the events for the current $modelversion and $taskid. The result list is filtered by the properties 'keypublicresult' and 'keyRestrictedVisibility'. If the property keyRestrictedVisibility exits the method test if the current username is listed in one of the namefields. If the current user is in the role 'org.imixs.ACCESSLEVEL.MANAGERACCESS' the property keyRestrictedVisibility will be ignored.

Parameters:

workitem -

Returns:

Throws:

ModelException

See Also:

imixs-bpmn

processWorkItem

public ItemCollection processWorkItem(ItemCollection workitem)
                               throws AccessDeniedException,
                                      ProcessingErrorException,
                                      PluginException,
                                      ModelException

This method processes a workItem by the WorkflowKernel and saves the workitem after the processing was finished successful. The workitem have to provide at least the properties '$modelversion', '$taskid' and '$eventid' Before the method starts processing the workitem, the method load the current instance of the given workitem and compares the property $taskID. If it is not equal the method throws an ProcessingErrorException. After the workitem was processed successful, the method verifies the property $workitemList. If this property holds a list of entities these entities will be saved and the property will be removed automatically. The method provides a observer pattern for plugins to get called during the processing phase.

Specified by:

processWorkItem in interface WorkflowManager

Parameters:

workitem - - the workItem to be processed

Returns:

updated version of the processed workItem

Throws:

AccessDeniedException - - thrown if the user has insufficient access to update the workItem

ProcessingErrorException - - thrown if the workitem could not be processed by the workflowKernel

PluginException - - thrown if processing by a plugin fails

ModelException

processWorkItem

public ItemCollection processWorkItem(ItemCollection workitem,
                                      ItemCollection event)
                               throws AccessDeniedException,
                                      ProcessingErrorException,
                                      PluginException,
                                      ModelException

This method processes a workItem based on a given event.

Parameters:

workitem - - the workItem to be processed

event - - event object

Returns:

updated version of the processed workItem

Throws:

AccessDeniedException - - thrown if the user has insufficient access to update the workItem

ProcessingErrorException - - thrown if the workitem could not be processed by the workflowKernel

PluginException - - thrown if processing by a plugin fails

ModelException

See Also:

ItemCollection processWorkItem(ItemCollection workitem)

processWorkItem

public ItemCollection processWorkItem(ItemCollection workitem,
                                      int eventID)
                               throws AccessDeniedException,
                                      ProcessingErrorException,
                                      PluginException,
                                      ModelException

This method processes a workItem based on a given event.

Parameters:

workitem - - the workItem to be processed

event - - event object

Returns:

updated version of the processed workItem

Throws:

AccessDeniedException - - thrown if the user has insufficient access to update the workItem

ProcessingErrorException - - thrown if the workitem could not be processed by the workflowKernel

PluginException - - thrown if processing by a plugin fails

ModelException

See Also:

ItemCollection processWorkItem(ItemCollection workitem)

removeWorkItem

public void removeWorkItem(ItemCollection aworkitem)
                    throws AccessDeniedException

Specified by:

removeWorkItem in interface WorkflowManager

Throws:

AccessDeniedException

getModelManager

public ModelManager getModelManager()

This Method returns the modelManager Instance. The current ModelVersion is automatically updated during the Method updateProfileEntity which is called from the processWorktiem method.

Specified by:

getModelManager in interface WorkflowContext

getSessionContext

public javax.ejb.SessionContext getSessionContext()

Returns an instance of the EJB session context.

Specified by:

getSessionContext in interface WorkflowContext

Returns:

getDocumentService

public DocumentService getDocumentService()

Returns an instance of the DocumentService EJB.

Returns:

getReportService

public ReportService getReportService()

Returns an instance of the ReportService EJB.

Returns:

getPropertyService

public PropertyService getPropertyService()

Returns an instance of the PropertyService EJB.

Returns:

getUserName

public String getUserName()

Obtain the java.security.Principal that identifies the caller and returns the name of this principal.

Returns:

the user name

isUserInRole

public boolean isUserInRole(String rolename)

Test if the caller has a given security role.

Parameters:

rolename -

Returns:

true if user is in role

getUserNameList

public List<String> getUserNameList()

This method returns a list of user names, roles and application groups the caller belongs to.

Returns:

adaptText

public String adaptText(String text,
                        ItemCollection documentContext)
                 throws PluginException

The method adaptText can be called to replace predefined xml tags included in a text with custom values. The method fires a CDI event to inform TextAdapterServices to parse and adapt a given text fragment.

Parameters:

text -

documentContext -

Returns:

Throws:

PluginException

adaptTextList

public List<String> adaptTextList(String text,
                                  ItemCollection documentContext)
                           throws PluginException

The method adaptTextList can be called to replace a text with custom values. The method fires a CDI event to inform TextAdapterServices to parse and adapt a given text fragment. The method expects a textList result.

Parameters:

text -

documentContext -

Returns:

Throws:

PluginException

evalWorkflowResult

public ItemCollection evalWorkflowResult(ItemCollection event,
                                         ItemCollection documentContext,
                                         boolean resolveItemValues)
                                  throws PluginException

The method evaluates the WorkflowResult for a given BPMN event and returns a ItemColleciton containing all item definitions. Each item definition of a WorkflowResult contains a name and a optional list of additional attributes. The method generates a item for each content element and attribute value.
e.g. text
will result in the attributes 'comment' with value 'text' and 'comment.ignore' with the value 'true' Also embedded itemVaues can be resolved (resolveItemValues=true): ABC$uniqueid This example will result in a new item 'somedata' with the $uniqueid prefixed with 'ABC'

Parameters:

event -

documentContext -

resolveItemValues - - if true, itemValue tags will be resolved.

Returns:

Throws:

PluginException

See Also:

parsing-using-regex-in-java.html

evalWorkflowResult

public ItemCollection evalWorkflowResult(ItemCollection activityEntity,
                                         ItemCollection documentContext)
                                  throws PluginException

The method evaluates the WorkflowResult of a BPMN event and resolves embedded ItemValues. * ABC$uniqueid This example will result in a new item 'somedata' with the $uniqueid prafixed with 'ABC'

Parameters:

activityEntity -

documentContext -

Returns:

Throws:

PluginException

See Also:

evalWorkflowResult(ItemCollection activityEntity, ItemCollection documentContext,boolean resolveItemValues)

evalNextTask

public ItemCollection evalNextTask(ItemCollection documentContext,
                                   ItemCollection event)
                            throws PluginException,
                                   ModelException

This method evaluates the next task based on a Model Event element. If the event did not point to a new task, the current task will be returned. The method supports the 'conditional-events' and 'split-events'. A conditional-event contains the attribute 'keyExclusiveConditions' defining conditional targets (tasks) or adds conditional follow up events A split-event contains the attribute 'keySplitConditions' defining the target for the current master version (condition evaluates to 'true')

Returns:

Task entity

Throws:

PluginException

ModelException