org.imixs.workflow.jee.ejb
Interface WorkflowService

All Superinterfaces:

org.imixs.workflow.WorkflowManager

All Known Subinterfaces:

WorkflowServiceRemote

public interface WorkflowService
extends org.imixs.workflow.WorkflowManager

The WorkflowService is the JEE Implementation for the IX Workflow 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. The ModelManager is independent form the IX JEE Entity EJBs and uses the standard IntemCollection Object as a data transfer object to comunitcate with clients.

Author:

rsoika

Field Summary

static int	SORT_ORDER_CREATED_ASC
static int	SORT_ORDER_CREATED_DESC
static int	SORT_ORDER_MODIFIED_ASC
static int	SORT_ORDER_MODIFIED_DESC

Method Summary

EntityService	getEntityService() This method returns an instance of the Imixs JEE EntityService used by the WorkflowManager Implementation.
ModelService	getModelService() This method returns an instance of the Imixs JEE ModelService used by the WorkflowManager Implementation.
String	getUserName() Obtain the java.security.Principal that identifies the caller and returns the name of this principal.
String[]	getUserRoles() Returns a String array containing all user roles the caller has given
Collection<org.imixs.workflow.ItemCollection>	getWorkList(String name, int startpos, int count, String type, int sortorder) Returns a collection of workitems belonging to a specified name.
Collection<org.imixs.workflow.ItemCollection>	getWorkListByCreator(String name, int startpos, int count, String type, int sortorder) Returns a collection of workitems created by a specified user (namCreator).
Collection<org.imixs.workflow.ItemCollection>	getWorkListByGroup(String name, int startpos, int count, String type, int sortorder) returns a collection of workitems belonging to a specified workflow group.
Collection<org.imixs.workflow.ItemCollection>	getWorkListByOwner(String name, int startpos, int count, String type, int sortorder) Returns a collection of workitems containing a namOwner property belonging to a specified username.
Collection<org.imixs.workflow.ItemCollection>	getWorkListByProcessID(int aID, int startpos, int count, String type, int sortorder) Returns a collection of workitems belonging to a specified $processID defined by the workflow model.
Collection<org.imixs.workflow.ItemCollection>	getWorkListByRef(String aref, int startpos, int count, String type, int sortorder) Returns a collection of workitems belonging to a specified workitem identified by the attribute $UniqueIDRef.
Collection<org.imixs.workflow.ItemCollection>	getWorkListByWriteAccess(int startpos, int count, String type, int sortorder) 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.

Methods inherited from interface org.imixs.workflow.WorkflowManager

getWorkItem, getWorkList, getWorkListByRef, processWorkItem, removeWorkItem

Field Detail

SORT_ORDER_CREATED_DESC

static final int SORT_ORDER_CREATED_DESC

See Also:

Constant Field Values

SORT_ORDER_CREATED_ASC

static final int SORT_ORDER_CREATED_ASC

See Also:

Constant Field Values

SORT_ORDER_MODIFIED_DESC

static final int SORT_ORDER_MODIFIED_DESC

See Also:

Constant Field Values

SORT_ORDER_MODIFIED_ASC

static final int SORT_ORDER_MODIFIED_ASC

See Also:

Constant Field Values

Method Detail

getWorkList

Collection<org.imixs.workflow.ItemCollection> getWorkList(String name,
                                                          int startpos,
                                                          int count,
                                                          String type,
                                                          int sortorder)
                                                          throws Exception

Returns a collection of workitems belonging to a specified name. 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

startpos - = optional start position

count - = optional count - default = -1

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)

Returns:

List of workitems

Throws:

Exception

getWorkListByGroup

Collection<org.imixs.workflow.ItemCollection> getWorkListByGroup(String name,
                                                                 int startpos,
                                                                 int count,
                                                                 String type,
                                                                 int sortorder)
                                                                 throws Exception

returns a collection of workitems belonging to a specified workflow group. The behaivor is simmilar to the method getWorkList.

Parameters:

name - = workflowgroup the workitems belong to

startpos - = optional start position

count - = optional count - default = -1

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)

Returns:

List of workitems

Throws:

Exception

getWorkListByProcessID

Collection<org.imixs.workflow.ItemCollection> getWorkListByProcessID(int aID,
                                                                     int startpos,
                                                                     int count,
                                                                     String type,
                                                                     int sortorder)
                                                                     throws Exception

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

Parameters:

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

startpos - = optional start position

count - = optional count - default = -1

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)

Returns:

List of workitems

Throws:

Exception

getWorkListByCreator

Collection<org.imixs.workflow.ItemCollection> getWorkListByCreator(String name,
                                                                   int startpos,
                                                                   int count,
                                                                   String type,
                                                                   int sortorder)
                                                                   throws Exception

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

Parameters:

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

startpos - = optional start position

count - = optional count - default = -1

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)

Returns:

List of workitems

Throws:

Exception

getWorkListByOwner

Collection<org.imixs.workflow.ItemCollection> getWorkListByOwner(String name,
                                                                 int startpos,
                                                                 int count,
                                                                 String type,
                                                                 int sortorder)
                                                                 throws Exception

Returns a collection of workitems containing a namOwner property belonging to a specified username. The namOwner property is typical controled by the OwnerPlugin

Parameters:

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

startpos - = optional start position

count - = optional count - default = -1

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)

Returns:

List of workitems

Throws:

Exception

getWorkListByWriteAccess

Collection<org.imixs.workflow.ItemCollection> getWorkListByWriteAccess(int startpos,
                                                                       int count,
                                                                       String type,
                                                                       int sortorder)
                                                                       throws Exception

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:

startpos - = optional start position

count - = optional count - default = -1

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)

Returns:

List of workitems

Throws:

Exception

getWorkListByRef

Collection<org.imixs.workflow.ItemCollection> getWorkListByRef(String aref,
                                                               int startpos,
                                                               int count,
                                                               String type,
                                                               int sortorder)
                                                               throws Exception

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 *

startpos - = optional start position

count - = optional count - default = -1

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)

Returns:

List of workitems

Throws:

Exception

getEntityService

EntityService getEntityService()
                               throws Exception

This method returns an instance of the Imixs JEE EntityService used by the WorkflowManager Implementation. The method can be used to access the EntityService during a Plugin call.

Returns:

EntityService

Throws:

Exception

getModelService

ModelService getModelService()
                             throws Exception

This method returns an instance of the Imixs JEE ModelService used by the WorkflowManager Implementation. The method can be used to access the ModelService during a Plugin call.

Returns:

EntityService

Throws:

Exception

getUserName

String getUserName()
                   throws Exception

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

Throws:

Exception

isUserInRole

boolean isUserInRole(String rolename)
                     throws Exception

Test if the caller has a given security role.

Parameters:

rolename -

Returns:

true if user is in role

Throws:

Exception

getUserRoles

String[] getUserRoles()
                      throws Exception

Returns a String array containing all user roles the caller has given

Returns:

String array with the users access roles

Throws:

Exception