wt.workflow.work
Interface WorkflowService

All Known Implementing Classes:

StandardWorkflowService, WorkflowServiceFwd

public interface WorkflowService

WorkflowService provides client invokable methods to workflow services. These methods are executed on the server side.

Supported API: false

Extendable: false

Method Summary

void	acceptAssignment(WorkItem workItem, WTUser user) Supported API: false
void	checkoutTo(WTObject object, WTPrincipalReference pRef, Role role, ActorRole actorRole, ObjectReference activityRef) checkout a business object to a principal.
void	createOverdueWorkItem(WfExecutionObject exec_obj) Creates a work item corresponding to the actions to be taken on an overdue execution object.
WTTableModel	createTableModel(String loadAction) This method is used to construct a worklist on the server and return it to the client.
WTTableModel	createTableModel(String loadAction, Vector groupBy, Vector sortBy) This method is used to construct a worklist on the server and return it to the client.
WTTableModel	createTableModel(String loadAction, Vector groupBy, Vector sortBy, WTObject contextObject) This method is used to construct a worklist on the server and return it to the client.
WfWorkListModel	createWorkListModel(String loadAction) This method is used to construct a worklist on the server and return it to the client.
WfWorkListModel	createWorkListModel(String loadAction, Vector groupBy, Vector sortBy) This method is used to construct a worklist on the server and return it to the client.
void	delegate(WorkItem workItem, WTPrincipal principal) Delegate a work item to a new owner Supported API: false
void	doDynamicUpdate(TeamReference team) Causes the workflow process instances using this team to re-resolve their actors and roles.
void	doDynamicUpdate(WfProcess process) Causes the workflow process instance passed in to re-resolve actors and roles from its associated Team.
Vector	getAssignees(WfAssignedActivity activity) Answer a vector of principals assigned to the activity Supported API: false
QueryResult	getUncompletedWorkItems() Answer an enumeration of all pending work items for all users Supported API: false
QueryResult	getUncompletedWorkItems(Integer query_limit, String sort_by_str) Answer an enumeration of all pending work items for all users, sorted and only the first nnn number of workitems returned.
QueryResult	getUncompletedWorkItems(Persistable object, Role role) Get pending work by object & role Supported API: false
QueryResult	getUncompletedWorkItems(Persistable object, String task) Get incomplete work items by object & task Supported API: false
QueryResult	getUncompletedWorkItems(Project2 context) Deprecated. use instead getUncompletedWorkItems (WTContainerRef.newWTContainerRef (project))
QueryResult	getUncompletedWorkItems(WTContainerRef context_ref) Answer an enumeration of incomplete work items for a project Supported API: false
QueryResult	getUncompletedWorkItems(WTPrincipal principal) Answer an enumeration of incomplete work items for a principal Supported API: false
QueryResult	getUncompletedWorkItems(WTPrincipal principal, Integer query_limit, String sort_by_str) Answer an enumeration of incomplete work items for a principal, sorted and only the first nnn number of workitems returned.
QueryResult	getUncompletedWorkItems(WTPrincipal principal, Project2 context) Deprecated. use instead getUncompletedWorkItems (WTUser, WTContainerRef.newWTContainerRef (project))
QueryResult	getUncompletedWorkItems(WTPrincipal principal, WTContainerRef context_ref) Answer an enumeration of incomplete work items for a principal within a project Supported API: false
QueryResult	getUncompletedWorkItems(WTPrincipal principal, WTContainerRef context_ref, Integer query_limit, String sort_by_str) Answer an enumeration of incomplete work items for a principal within a WTContainer, sorted and only the first nnn number of workitems returned.
QueryResult	getWorkItems() Answer an enumeration of all pending work items for all users Supported API: false
QueryResult	getWorkItems(Persistable object) Answer an enumeration of work items for an object Supported API: false
QueryResult	getWorkItems(Persistable object, Role role) Get work by object & role Supported API: false
QueryResult	getWorkItems(Persistable object, String source) Answer an enumeration of work items for an object & source Supported API: false
QueryResult	getWorkItems(Persistable object, WTPrincipal principal) Get work by object & principa Supported API: false
QueryResult	getWorkItems(Persistable object, WTPrincipal principal, Role role) Get work by object & principal & role Supported API: false
QueryResult	getWorkItems(Persistable object, WTPrincipal principal, String task) Get work by object & principal & task Supported API: false
QueryResult	getWorkItems(String source) Answer an enumeration of work items created by a specific source Supported API: false
QueryResult	getWorkItems(WTPrincipal principal) Answer an enumeration of work items for a principal Supported API: false
QueryResult	getWorkItems(WTPrincipal principal, Role role) Answer an enumeration of work items for a principal for a specific role Supported API: false
boolean	isOffered(WorkItem workItem) This is the method that indicates whether a WorkItem is offered and capable of being Accepted.
void	markWorkItemComplete(Persistable object, WTPrincipal completedBy, Role role) Mark the work item defined by user, object & role as complete.
void	markWorkItemComplete(Persistable object, WTPrincipal completedBy, String task) Mark the work item defined by user, object & task as complete.
void	markWorkItemComplete(WorkItem workItem, WTPrincipalReference completedBy) Deprecated. Since R2 Mark the work item complete.
void	markWorkItemIncomplete(Persistable object, WTPrincipal completedBy, Role role) Mark the work item defined by user, object & role as NOT complete.
void	reassignActivity(WfAssignedActivity activity) Reassigns activity to principal referred to by special activity variable.
void	reassignActivity(WfAssignedActivity activity, WTPrincipal principal) Reassigns activity to principal referred to principal passed as parameter.
String	replaceVariables(String txt, ProcessData variables) Utility method that replaces values for variables whenever they occur.
void	sendNotification(String subject, String msgBody, Vector recipients, Vector roles, Vector actorRoles, Vector projects, Vector variables, ObjectReference activityReference) sendNotification resolves the principals and sends notification to them.
void	sendNotification(String msgBody, Vector recipients, Vector roles, Vector actorRoles, ObjectReference activityReference) send email to a recipient list Supported API: false
boolean	tally(WfAssignedActivity self, WfTallyType policy, String operator, int value, String event) This is the tally method that is called from the Custom Routing Event/...Event Firing Expression.
void	workComplete(ObjectReference workItemRef, WTPrincipalReference principalRef, Vector eventList) Declare a workItem complete and transmit the event(s) to trigger.
void	workComplete(WorkItem workItem, WTPrincipalReference principalRef, Vector eventList) Declare a workItem complete and transmit the event(s) to trigger.

Method Detail

getWorkItems

public QueryResult getWorkItems(WTPrincipal principal)
                         throws WTException,
                                WfException

Answer an enumeration of work items for a principal

Supported API: false

Parameters:

principal - the assigned-to WTPrincipal used as search criteria

Returns:

QueryResult

Throws:

WTException

WfException

getUncompletedWorkItems

public QueryResult getUncompletedWorkItems(WTPrincipal principal)
                                    throws WTException,
                                           WfException

Answer an enumeration of incomplete work items for a principal

Supported API: false

Parameters:

principal - the assigned-to WTPrincipal used as search criteria

Returns:

QueryResult

Throws:

WTException

WfException

getWorkItems

public QueryResult getWorkItems(WTPrincipal principal,
                                Role role)
                         throws WTException,
                                WfException

Answer an enumeration of work items for a principal for a specific role

Supported API: false

Parameters:

principal - the assigned-to WTPrincipal used as search criteria

role - the Role object used as search criteria

Returns:

QueryResult

Throws:

WTException

WfException

getWorkItems

public QueryResult getWorkItems(String source)
                         throws WTException,
                                WfException

Answer an enumeration of work items created by a specific source

Supported API: false

Parameters:

source - the name of the process (theLifeCycleTemplate) that created the WorkItem used as a search criteria

Returns:

QueryResult

Throws:

WTException

WfException

getWorkItems

public QueryResult getWorkItems(Persistable object)
                         throws WTException,
                                WfException

Answer an enumeration of work items for an object

Supported API: false

Parameters:

object - the persistable lifecyclemanaged object that is used as the search criteria

Returns:

QueryResult

Throws:

WTException

WfException

getWorkItems

public QueryResult getWorkItems(Persistable object,
                                String source)
                         throws WTException,
                                WfException

Answer an enumeration of work items for an object & source

Supported API: false

Parameters:

object - the persistable lifecyclemanaged object that is used as the search criteria

source - the name of the process (the LifeCycleTemplate name) that caused the work item to be created used as search criteria

Returns:

QueryResult

Throws:

WTException

WfException

getWorkItems

public QueryResult getWorkItems(Persistable object,
                                WTPrincipal principal,
                                Role role)
                         throws WTException,
                                WfException

Get work by object & principal & role

Supported API: false

Parameters:

object - the persistable lifecyclemanaged object that is used as search criteria

principal - the assigned-to WTPrincipal that is used as search critieria

role - the role object that is used as search criteria

Returns:

QueryResult

Throws:

WTException

WfException

getWorkItems

public QueryResult getWorkItems(Persistable object,
                                WTPrincipal principal,
                                String task)
                         throws WTException,
                                WfException

Get work by object & principal & task

Supported API: false

Parameters:

object - the persistable lifecyclemanaged object that is used as search criteria

principal - the assigned-to WTPrincipal that is used as search critieria

task - the task that is used as search criteria

Returns:

QueryResult

Throws:

WTException

WfException

getWorkItems

public QueryResult getWorkItems(Persistable object,
                                WTPrincipal principal)
                         throws WTException,
                                WfException

Get work by object & principa

Supported API: false

Parameters:

object - the persistable lifecyclemanaged object that is used as search criteria

principal - the assigned-to WTPrincipal that is used as search critieria

Returns:

QueryResult

Throws:

WTException

WfException

getWorkItems

public QueryResult getWorkItems(Persistable object,
                                Role role)
                         throws WTException,
                                WfException

Get work by object & role

Supported API: false

Parameters:

object - the persistable lifecyclemanaged object that is used as search criteria

role - the role object that is used as search criteria

Returns:

QueryResult

Throws:

WTException

WfException

getUncompletedWorkItems

public QueryResult getUncompletedWorkItems(Persistable object,
                                           Role role)
                                    throws WTException,
                                           WfException

Get pending work by object & role

Supported API: false

Parameters:

object - the persistable lifecyclemanaged object that is used as search criteria

role - the role object that is used as search criteria

Returns:

QueryResult

Throws:

WTException

WfException

getWorkItems

public QueryResult getWorkItems()
                         throws WTException,
                                WfException

Answer an enumeration of all pending work items for all users

Supported API: false

Returns:

QueryResult

Throws:

WTException

WfException

getUncompletedWorkItems

public QueryResult getUncompletedWorkItems()
                                    throws WTException,
                                           WfException

Answer an enumeration of all pending work items for all users

Supported API: false

Returns:

QueryResult

Throws:

WTException

WfException

getUncompletedWorkItems

public QueryResult getUncompletedWorkItems(Persistable object,
                                           String task)
                                    throws WTException,
                                           WfException

Get incomplete work items by object & task

Supported API: false

Parameters:

object - the persistable lifecyclemanaged object that is used as search criteria

task - the task that is used as search criteria

Returns:

QueryResult

Throws:

WTException

WfException

getAssignees

public Vector getAssignees(WfAssignedActivity activity)
                    throws WTException,
                           WfException

Answer a vector of principals assigned to the activity

Supported API: false

Parameters:

activity -

Returns:

Vector

Throws:

WTException

WfException

workComplete

public void workComplete(WorkItem workItem,
                         WTPrincipalReference principalRef,
                         Vector eventList)
                  throws WTException,
                         WfException

Declare a workItem complete and transmit the event(s) to trigger.

Supported API: false

Parameters:

workItem -

principalRef -

eventList -

Throws:

WTException

WfException

workComplete

public void workComplete(ObjectReference workItemRef,
                         WTPrincipalReference principalRef,
                         Vector eventList)
                  throws WTException,
                         WfException

Declare a workItem complete and transmit the event(s) to trigger.

Supported API: false

Parameters:

workItemRef -

principalRef -

eventList -

Throws:

WTException

WfException

markWorkItemComplete

public void markWorkItemComplete(WorkItem workItem,
                                 WTPrincipalReference completedBy)
                          throws WTException,
                                 WfException

Deprecated. Since R2 Mark the work item complete.

Supported API: false

Parameters:

workItem -

completedBy - the performer of the work

Throws:

WTException

WfException

markWorkItemComplete

public void markWorkItemComplete(Persistable object,
                                 WTPrincipal completedBy,
                                 Role role)
                          throws WTException,
                                 WfException

Mark the work item defined by user, object & role as complete.

Supported API: false

Parameters:

object - the life cycle managed object associated with the work item

completedBy - the performer of the work

role - the role played by the actor

Throws:

WTException

WfException

markWorkItemComplete

public void markWorkItemComplete(Persistable object,
                                 WTPrincipal completedBy,
                                 String task)
                          throws WTException,
                                 WfException

Mark the work item defined by user, object & task as complete.

Supported API: false

Parameters:

object - the life cycle managed object associated with the work item

completedBy - the performer of the work

task - the role played by the actor

Throws:

WTException

WfException

markWorkItemIncomplete

public void markWorkItemIncomplete(Persistable object,
                                   WTPrincipal completedBy,
                                   Role role)
                            throws WTException,
                                   WfException

Mark the work item defined by user, object & role as NOT complete.

Supported API: false

Parameters:

object - the life cycle managed object associated with the work item

completedBy - the performer of the work

role - the role played by the completedBy principal

Throws:

WTException

WfException

acceptAssignment

public void acceptAssignment(WorkItem workItem,
                             WTUser user)
                      throws WTException,
                             WfException

Supported API: false

Parameters:

workItem -

user -

Throws:

WTException

WfException

delegate

public void delegate(WorkItem workItem,
                     WTPrincipal principal)
              throws WTException,
                     WfException

Delegate a work item to a new owner

Supported API: false

Parameters:

workItem -

principal -

Throws:

WTException

WfException

sendNotification

public void sendNotification(String msgBody,
                             Vector recipients,
                             Vector roles,
                             Vector actorRoles,
                             ObjectReference activityReference)
                      throws WTException

send email to a recipient list

Supported API: false

Parameters:

msgBody -

recipients -

roles -

actorRoles -

activityReference -

Throws:

WTException

sendNotification

public void sendNotification(String subject,
                             String msgBody,
                             Vector recipients,
                             Vector roles,
                             Vector actorRoles,
                             Vector projects,
                             Vector variables,
                             ObjectReference activityReference)
                      throws WTException

sendNotification resolves the principals and sends notification to them.

Supported API: false

Parameters:

subject -

msgBody -

recipients -

roles -

actorRoles -

projects -

variables -

activityReference -

Throws:

WTException

checkoutTo

public void checkoutTo(WTObject object,
                       WTPrincipalReference pRef,
                       Role role,
                       ActorRole actorRole,
                       ObjectReference activityRef)
                throws WTException

checkout a business object to a principal. Intended for robot usage

Supported API: false

Parameters:

object -

pRef -

role -

actorRole -

activityRef -

Throws:

WTException

createWorkListModel

public WfWorkListModel createWorkListModel(String loadAction)
                                    throws WTException

This method is used to construct a worklist on the server and return it to the client. The created worklist will contain either work items for all users, or work items for the current user.

Supported API: false

Parameters:

loadAction - The type of load action to be performed on the work list. Valid values are 'worklist-load-user' to load work items for the current user, or 'worklist-load-admin' to load work items for all users.

Returns:

WfWorkListModel

Throws:

WTException

createWorkListModel

public WfWorkListModel createWorkListModel(String loadAction,
                                           Vector groupBy,
                                           Vector sortBy)
                                    throws WTException

This method is used to construct a worklist on the server and return it to the client. The created worklist will contain either work items for all users, or work items for the current user.

Supported API: false

Parameters:

loadAction - The type of load action to be performed on the work list. Valid values are 'worklist-load-user' to load work items for the current user, or 'worklist-load-admin' to load work items for all users.

groupBy - The ordered list of columns to be grouped for the work list. If no grouping is required then this parameter may be set to 'null' or an empty Vector may be sent in. Otherwise, this parameter takes a vector (of Strings) of column names to be grouped. The first column listed in the vector will be the first column grouped.

sortBy - The ordered list of columns to be sorted for the work list. If no sorting is required then this parameter may be set to 'null' or an empty Vector may be sent in. Otherwise, this parameter takes a vector (of Strings) of column names to be sorted. The first column listed in the vector will be the first column sorted.

Returns:

WfWorkListModel

Throws:

WTException

createOverdueWorkItem

public void createOverdueWorkItem(WfExecutionObject exec_obj)
                           throws WTException

Creates a work item corresponding to the actions to be taken on an overdue execution object.

Supported API: false

Parameters:

exec_obj -

Throws:

WTException

reassignActivity

public void reassignActivity(WfAssignedActivity activity)
                      throws WTException

Reassigns activity to principal referred to by special activity variable.

Supported API: false

Parameters:

activity -

Throws:

WTException

reassignActivity

public void reassignActivity(WfAssignedActivity activity,
                             WTPrincipal principal)
                      throws WTException

Reassigns activity to principal referred to principal passed as parameter.

Supported API: false

Parameters:

activity -

principal -

Throws:

WTException

createTableModel

public WTTableModel createTableModel(String loadAction)
                              throws WTException

This method is used to construct a worklist on the server and return it to the client. The created worklist will contain either work items for all users, or work items for the current user.

Supported API: false

Parameters:

loadAction - The type of load action to be performed on the work list. Valid values are 'worklist-load-user' to load work items for the current user, or 'worklist-load-admin' to load work items for all users.

Returns:

WTTableModel

Throws:

WTException

createTableModel

public WTTableModel createTableModel(String loadAction,
                                     Vector groupBy,
                                     Vector sortBy)
                              throws WTException

This method is used to construct a worklist on the server and return it to the client. The created worklist will contain either work items for all users, or work items for the current user.

Supported API: false

Parameters:

loadAction - The type of load action to be performed on the work list. Valid values are 'worklist-load-user' to load work items for the current user, or 'worklist-load-admin' to load work items for all users.

groupBy - The ordered list of columns to be grouped for the work list. If no grouping is required then this parameter may be set to 'null' or an empty Vector may be sent in. Otherwise, this parameter takes a vector (of Strings) of column names to be grouped. The first column listed in the vector will be the first column grouped.

sortBy - The ordered list of columns to be sorted for the work list. If no sorting is required then this parameter may be set to 'null' or an empty Vector may be sent in. Otherwise, this parameter takes a vector (of Strings) of column names to be sorted. The first column listed in the vector will be the first column sorted.

Returns:

WTTableModel

Throws:

WTException

createTableModel

public WTTableModel createTableModel(String loadAction,
                                     Vector groupBy,
                                     Vector sortBy,
                                     WTObject contextObject)
                              throws WTException

This method is used to construct a worklist on the server and return it to the client. The created worklist will contain either work items for all users, or work items for the current user.

Supported API: false

Parameters:

loadAction - The type of load action to be performed on the work list. Valid values are 'worklist-load-user' to load work items for the current user, or 'worklist-load-admin' to load work items for all users.

groupBy - The ordered list of columns to be grouped for the work list. If no grouping is required then this parameter may be set to 'null' or an empty Vector may be sent in. Otherwise, this parameter takes a vector (of Strings) of column names to be grouped. The first column listed in the vector will be the first column grouped.

sortBy - The ordered list of columns to be sorted for the work list. If no sorting is required then this parameter may be set to 'null' or an empty Vector may be sent in. Otherwise, this parameter takes a vector (of Strings) of column names to be sorted. The first column listed in the vector will be the first column sorted.

contextObject -

Returns:

WTTableModel

Throws:

WTException

tally

public boolean tally(WfAssignedActivity self,
                     WfTallyType policy,
                     String operator,
                     int value,
                     String event)
              throws WTException

This is the tally method that is called from the Custom Routing Event/...Event Firing Expression. It is exposed here for future client customization.

Supported API: false

Parameters:

self -

policy -

operator -

value -

event -

Returns:

boolean

Throws:

WTException

replaceVariables

public String replaceVariables(String txt,
                               ProcessData variables)
                        throws WTException

Utility method that replaces values for variables whenever they occur. The parameters are a text String and a ProcessData object that holds the variables whose values must be replaced. In the text, a variable occurrence is represented by {var_name}, where:

• var_name is the name of the variable
• the delimiter characters '{' and '}' can be escaped by preceding hem by ''

The delimiter characters can be defined in wt.properties. The default are open and close curly braces ('{' and '}').

Supported API: false

Parameters:

txt -

variables -

Returns:

String

Throws:

WTException

getUncompletedWorkItems

public QueryResult getUncompletedWorkItems(WTContainerRef context_ref)
                                    throws WTException,
                                           WfException

Answer an enumeration of incomplete work items for a project

Supported API: false

Parameters:

context_ref -

Returns:

QueryResult

Throws:

WTException

WfException

getUncompletedWorkItems

public QueryResult getUncompletedWorkItems(Project2 context)
                                    throws WTException

Deprecated. use instead getUncompletedWorkItems (WTContainerRef.newWTContainerRef (project))

Supported API: false

Parameters:

context -

Returns:

QueryResult

Throws:

WTException

getUncompletedWorkItems

public QueryResult getUncompletedWorkItems(WTPrincipal principal,
                                           WTContainerRef context_ref)
                                    throws WTException,
                                           WfException

Answer an enumeration of incomplete work items for a principal within a project

Supported API: false

Parameters:

principal - the assigned-to WTPrincipal used as search criteria

context_ref -

Returns:

QueryResult

Throws:

WTException

WfException

getUncompletedWorkItems

public QueryResult getUncompletedWorkItems(WTPrincipal principal,
                                           Project2 context)
                                    throws WTException

Deprecated. use instead getUncompletedWorkItems (WTUser, WTContainerRef.newWTContainerRef (project))

Supported API: false

Parameters:

principal -

context -

Returns:

QueryResult

Throws:

WTException

doDynamicUpdate

public void doDynamicUpdate(TeamReference team)
                     throws WTException

Causes the workflow process instances using this team to re-resolve their actors and roles. This method will immediately update the assignments of all WfAssignedActivities.

Supported API: false

Parameters:

team -

Throws:

WTException

doDynamicUpdate

public void doDynamicUpdate(WfProcess process)
                     throws WTException

Causes the workflow process instance passed in to re-resolve actors and roles from its associated Team. This method will immediately update all assignments for open, running WfAssignedActivities.

Supported API: false

Parameters:

process -

Throws:

WTException

isOffered

public boolean isOffered(WorkItem workItem)
                  throws WTException

This is the method that indicates whether a WorkItem is offered and capable of being Accepted.

Supported API: false

Parameters:

workItem -

Returns:

boolean

Throws:

WTException

getUncompletedWorkItems

public QueryResult getUncompletedWorkItems(WTPrincipal principal,
                                           WTContainerRef context_ref,
                                           Integer query_limit,
                                           String sort_by_str)
                                    throws WTException,
                                           WfException

Answer an enumeration of incomplete work items for a principal within a WTContainer, sorted and only the first nnn number of workitems returned.

Supported API: false

Parameters:

principal - the assigned-to WTPrincipal used as search criteria

context_ref -

query_limit -

sort_by_str -

Returns:

QueryResult

Throws:

WTException

WfException

getUncompletedWorkItems

public QueryResult getUncompletedWorkItems(WTPrincipal principal,
                                           Integer query_limit,
                                           String sort_by_str)
                                    throws WTException,
                                           WfException

Answer an enumeration of incomplete work items for a principal, sorted and only the first nnn number of workitems returned.

Supported API: false

Parameters:

principal - the assigned-to WTPrincipal used as search criteria

query_limit -

sort_by_str -

Returns:

QueryResult

Throws:

WTException

WfException

getUncompletedWorkItems

public QueryResult getUncompletedWorkItems(Integer query_limit,
                                           String sort_by_str)
                                    throws WTException,
                                           WfException

Answer an enumeration of all pending work items for all users, sorted and only the first nnn number of workitems returned.

Supported API: false

Parameters:

query_limit -

sort_by_str -

Returns:

QueryResult

Throws:

WTException

WfException