wt.workflow.engine
Interface WfEngineService

All Known Implementing Classes:

StandardWfEngineService, WfEngineServiceFwd

public interface WfEngineService

This class WfEngineService represents the client accessible API to the workflow engine. It contains, for example, methods to create and start processes.

Supported API: true

Extendable: false

Method Summary

void	changeEventConfiguration(WfProcess process, WfEventConfiguration evt_cfg) Changes the process' event configuration to the one passed as argument.
WfExecutionObject	changeState(WfExecutionObject exec_object, WfTransition transition) Changes the state of a process or activity.
WfActivity	complete(WfActivity activity, Vector selected_events) Completes activity and generates events.
WfProcess	createAdHocProcess(WfTemplateObject template, Object team_spec) Deprecated. use method with WTContainerRef
WfProcess	createAdHocProcess(WfTemplateObject template, Object team_spec, WTContainerRef context_ref) Creates a process given a template object that can be a process template, a block template or an activity template.
WfRequesterActivity	createBlockProcess(WfBlockTemplate template, WfContainer container) Creates a block process and requester activity given the block template and containing process.
WfRequesterActivity	createNestedProcess(WfProcessTemplate template, WfContainer container) Creates an activity requester and an associated process from the template.
WfProcess	createProcess(WfProcessDefinition template, Object team_spec) Deprecated. use method with WTContainerRef
WfProcess	createProcess(WfProcessDefinition template, Object team_spec, WTContainerRef context_ref) Creates and returns a process from the given template, associated team specification and a reference to the context (@link wt.inf.container.WTContainerRef} where the process is to be created.
WTValuedMap	createProcesses(WTValuedMap objToWfDefMap, WTKeyedMap objToWfNameMap, WTCollection collection, boolean setTeamFromPbo, long priority) Creates and returns a WTValuedMap of objects to WfProcess.
WTValuedMap	createProcesses(WTValuedMap objToWfDefMap, WTKeyedMap objToWfNameMap, WTCollection collection, boolean setTeamFromPbo, long priority, WTContainerRef context_ref) Creates and returns a WTValuedMap of objects to WfProcess.
WfContainer	createStartAdHocProcess(WfAdHocActivity requester, WfContainerTemplate template) Creates and starts an adh hoc process given the ad hoc activity and the template from which the process should be instantiated.
void	deleteClosedProcesses(SearchCondition condition) Delete all closed processes that meet the search condition passed as argument.
void	deleteProcess(WfProcess process) Deletes process passed as argument.
WTCollection	getAssignmentEvents(WfProcess process, Role role, WTPrincipalReference new_assignee_ref, WTPrincipalReference old_assignee_ref, WTReference bus_obj_ref) Returns all the reassignment events for the process, role, old assignee, new assignee and business object passed as argument.
Enumeration	getAssociatedProcesses(Persistable object, WfState state) Deprecated. use method with WTContainerRef argument.
QueryResult	getAssociatedProcesses(Persistable object, WfState state, WTContainerRef context_ref) Returns all process instances associated with the object passed as argument that are in a given state in the passed WTContainer.
WTCollection	getDataEvents(WfExecutionObject exec_obj, Role role, WTPrincipalReference user_ref, WTReference bus_obj_ref) Returns all the data events for the execution object (process or activity), role, assignee, and business object passed as arguments.
Enumeration	getHistory(WfEventAuditType eventType) Returns a list of all events of a given type associated with execution objects.
Enumeration	getHistory(WfExecutionObject obj, WfEventAuditType eventType) Returns a list of all events associated with a given execution object of a given type.
Enumeration	getOverdueActivities(WfProcess process) Returns all overdue activities contained in a given process.
Enumeration	getOverdueProcesses() Deprecated. use method with WTContainerRef as argument.
QueryResult	getOverdueProcesses(WTContainerRef context_ref) Returns all overdue processes in a given WTContainer.
Enumeration	getProcessConnectors(WfContainer container) Returns all connectors contained in a given process.
Enumeration	getProcesses(WfProcessTemplate template, WfState state) Returns all processes instantianted from a given template that are in a given state.
Enumeration	getProcesses(WfState state) Deprecated. use method with WTContainerRef as argument.
QueryResult	getProcesses(WfState state, WTContainerRef context_ref) Returns all existing processes in a given state and WTContainer.
HashMap	getProcessNodeDueDates(WfProcess process) Returns a HashMap.
HashMap	getProcessNodeDueDates(WfProcessTemplate pt) Returns a HashMap.
HashMap	getProcessNodeDurations(WfProcess process) Returns a HashMap.
HashMap	getProcessNodeDurations(WfProcessTemplate pt) Returns a HashMap.
HashMap	getProcessNodeInstructions(WfProcess process) Returns a HashMap.
HashMap	getProcessNodeInstructions(WfProcessTemplate processTemplate) Returns a HashMap.
HashMap	getProcessNodeNotifications(WfProcess process) Returns a HashMap.
HashMap	getProcessNodeNotifications(WfProcessTemplate pt) Returns a HashMap.
Vector	getProcessRoles(WfProcess process) Answer a vector of role objects declared by the process Supported API: true
Enumeration	getProcessSteps(WfContainer container, WfState state) Returns all instantiated process steps in a given state.
String	getProjectName(WfContainer container) Returns the name of the project associated with the given process.
URL	getRelatedProcessesURL(WTObject obj) Returns a URL to view associated workflow processes given a business object.
WTPrincipal	getResponsible(WfExecutionObject exec_obj) Returns principal responsible for the execution object.
Enumeration	getResponsibleParticipants(WfExecutionObject exec_obj) Returns an Enumeration of principal references who are responsible for the execution object.
String	getTeamName(WfContainer container) Returns the name of the team associated with the given process.
WTCollection	getVotingEvents(WfProcess process, Role role, WTPrincipalReference user_ref, WTReference bus_obj_ref) Returns all the voting events for the process, role, assignee and business object passed as argument.
AdminDomainRef	getWfDomain(WTObject pbo, WTContainerRef context_ref) Gets the AdminDomainRef given the associated business object and the context.
Folder	getWfFolder(String folder_name) Deprecated. use method with the same name with two additional parameters: the primary business object and the container of the process.
Folder	getWfFolder(String folder_path, WTObject pbo, WTContainerRef context_ref) Gets folder given its relative path, associated business object and the context.
void	setIgnoreDelete(Object obj) Supported API: false
void	setProcessNodeDueDates(ObjectReference process, HashMap hash) Takes an ObjectReference to a process and a HashMap of ObjectReference->WfDueDate paris.
void	setProcessNodeDurations(ObjectReference process, HashMap hash) Takes an ObjectReference to a process and a HashMap of ObjectReference->WfDuration paris.
void	setProcessNodeInstructions(ObjectReference process, HashMap hash) Takes an ObjectReference to a process and a HashMap of ObjectReference->WfInstructions pairs.
void	setProcessNodeNotifications(ObjectReference process, HashMap hash) Takes an ObjectReference to a process and a HashMap of ObjectReference->WfAssigneeNotification paris.
WfProcess	startProcess(WfProcess process, ProcessData input, long priority) Starts a process with given input data and priority.
WfProcess	startProcess(WfProcess process, ProcessData input, long priority, Timestamp start_time, Timestamp deadline) Start a process given, in addition to the input data, absolute start time and deadline.
WTCollection	startProcesses(WTCollection processes) Queues the start of all WfProcess objects in the given WTCollection.
WfProcess	startProcessImmediate(WfProcess process, ProcessData input, long priority) Starts a process with given input data and priority without creation of new thread or queue entries.
void	terminateObjectsRunningWorkflows(Persistable object) if terminateObjectsRunningWorkflows=true, terminate all the objects running processes.
void	terminateObjectsRunningWorkflows(WTCollection collection) if terminateObjectsRunningWorkflows=true, terminate all the objects running processes.
Vector	whereUsed(ProjectReference project, boolean returnOnlyFirstOccurrence) Returns a vector of references to any defintion objects that use a particular Project object Supported API: false
Vector	whereUsed(TeamReference teamRef, boolean returnOnlyFirstOccurrence) Returns a vector of references to any defintion objects that use a particular Team object Supported API: false
Vector	whereUsed(TeamTemplateReference teamTemplateRef, boolean returnOnlyFirstOccurrence) Returns a vector of references to any defintion objects that use a particular TeamTemplate object Supported API: false

Method Detail

startProcess

public WfProcess startProcess(WfProcess process,
                              ProcessData input,
                              long priority)
                       throws WTException

Starts a process with given input data and priority. Returns started process.

Supported API: true

Parameters:

process -

input -

priority -

Returns:

WfProcess

Throws:

WTException

setIgnoreDelete

public void setIgnoreDelete(Object obj)
                     throws WTException

Supported API: false

Parameters:

obj -

Throws:

WTException

getProcesses

public Enumeration getProcesses(WfState state)
                         throws WTException

Deprecated. use method with WTContainerRef as argument.

Returns all existing processes in a given state. For example, one can ask for all OPEN processes (irrespective of its substates). If state is null all processes are returned irrespective of their states.

Supported API: false

Parameters:

state -

Returns:

Enumeration

Throws:

WTException

getProcesses

public Enumeration getProcesses(WfProcessTemplate template,
                                WfState state)
                         throws WTException

Returns all processes instantianted from a given template that are in a given state. For example, one can ask for all CLOSED processes (irrespective of its substates). If state is null all processes are returned irrespective of their states.

Supported API: true

Parameters:

template -

state -

Returns:

Enumeration

Throws:

WTException

getProcessSteps

public Enumeration getProcessSteps(WfContainer container,
                                   WfState state)
                            throws WTException

Returns all instantiated process steps in a given state. If state is null all steps are returned irrespective of their states.

Supported API: true

Parameters:

container -

state -

Returns:

Enumeration

Throws:

WTException

getProcessNodeDueDates

public HashMap getProcessNodeDueDates(WfProcessTemplate pt)
                               throws WTException

Returns a HashMap. The key being a WfAssignedActifvityTemplate's ObjectReference. The value is the WfDueDate object associatedwith this activity.

Supported API: false

Parameters:

pt -

Returns:

HashMap

Throws:

WTException

getProcessConnectors

public Enumeration getProcessConnectors(WfContainer container)
                                 throws WTException

Returns all connectors contained in a given process.

Supported API: true

Parameters:

container -

Returns:

Enumeration

Throws:

WTException

getProcessRoles

public Vector getProcessRoles(WfProcess process)
                       throws WTException

Answer a vector of role objects declared by the process

Supported API: true

Parameters:

process -

Returns:

Vector

Throws:

WTException

changeState

public WfExecutionObject changeState(WfExecutionObject exec_object,
                                     WfTransition transition)
                              throws WTException

Changes the state of a process or activity. Throws exception if transition is not allowed (for example, trying to stop a closed object).

Supported API: true

Parameters:

exec_object -

transition -

Returns:

WfExecutionObject

Throws:

WTException

getHistory

public Enumeration getHistory(WfExecutionObject obj,
                              WfEventAuditType eventType)
                       throws WTException

Returns a list of all events associated with a given execution object of a given type. It the type is "null" returns of events associated with the object.

Supported API: true

Parameters:

obj -

eventType -

Returns:

Enumeration

Throws:

WTException

deleteClosedProcesses

public void deleteClosedProcesses(SearchCondition condition)
                           throws WTException

Delete all closed processes that meet the search condition passed as argument. Deletes all closed processes if the search condition is "null".

Supported API: true

Parameters:

condition -

Throws:

WTException

getOverdueProcesses

public Enumeration getOverdueProcesses()
                                throws WTException

Deprecated. use method with WTContainerRef as argument.

Returns all overdue processes. An overdue process is one that its deadline has passed.

Supported API: true

Returns:

Enumeration

Throws:

WTException

getOverdueActivities

public Enumeration getOverdueActivities(WfProcess process)
                                 throws WTException

Returns all overdue activities contained in a given process. An overdue activity is one that its deadline has passed.

Supported API: true

Parameters:

process -

Returns:

Enumeration

Throws:

WTException

complete

public WfActivity complete(WfActivity activity,
                           Vector selected_events)
                    throws WTException

Completes activity and generates events. This method is used to provoke a change of state (transition = COMPLETE) and, at the same time, pass a Vector containing selected user events. If the activity is a manual router (routerType= MANUAL) the event is used to trigger the appropriate successor links; otherwise it is ignored.

Supported API: true

Parameters:

activity -

selected_events -

Returns:

WfActivity

Throws:

WTException

getProjectName

public String getProjectName(WfContainer container)
                      throws WTException

Returns the name of the project associated with the given process. If there is none (as it can be the case of robot activities) or the role holder object doesn't have a name then the method returns 'null'.

Supported API: true

Parameters:

container -

Returns:

String

Throws:

WTException

createProcess

public WfProcess createProcess(WfProcessDefinition template,
                               Object team_spec)
                        throws WTException

Deprecated. use method with WTContainerRef

Creates and returns a process from the given template and associated team specification. If name is null the process name is the same as the template.

A team specification can be one of the following:

• RoleHolder (deprecated)
• wt.team.TeamRef
• wt.team.TeamTeamplateRef
• LifeCycleManaged

  Import Note: The process will be created in the same WTContainer as the team spec passed as argument, except in the case the team spec is a wt.team.TeamTeamplateRef, in which case the process is created in the classic container. There is a similar method with the same name that accepts an additional argument that is a reference to the container where the process is to be created.
  
  Supported API: true

  Parameters:

  template -

  team_spec -

  Returns:

  WfProcess

  Throws:

  WTException

createNestedProcess

public WfRequesterActivity createNestedProcess(WfProcessTemplate template,
                                               WfContainer container)
                                        throws WTException

Creates an activity requester and an associated process from the template.

Supported API: false

Parameters:

template -

container -

Returns:

WfRequesterActivity

Throws:

WTException

getHistory

public Enumeration getHistory(WfEventAuditType eventType)
                       throws WTException

Returns a list of all events of a given type associated with execution objects. It the type is "null" returns of events associated with the object.

Supported API: true

Parameters:

eventType -

Returns:

Enumeration

Throws:

WTException

changeEventConfiguration

public void changeEventConfiguration(WfProcess process,
                                     WfEventConfiguration evt_cfg)
                              throws WTException

Changes the process' event configuration to the one passed as argument. All activities' configurations are changed as well.

Supported API: true

Parameters:

process -

evt_cfg -

Throws:

WTException

deleteProcess

public void deleteProcess(WfProcess process)
                   throws WTException

Deletes process passed as argument.

Supported API: true

Parameters:

process -

Throws:

WTException

startProcessImmediate

public WfProcess startProcessImmediate(WfProcess process,
                                       ProcessData input,
                                       long priority)
                                throws WTException

Starts a process with given input data and priority without creation of new thread or queue entries. Returns started process.

Supported API: true

Parameters:

process -

input -

priority -

Returns:

WfProcess

Throws:

WTException

createBlockProcess

public WfRequesterActivity createBlockProcess(WfBlockTemplate template,
                                              WfContainer container)
                                       throws WTException

Creates a block process and requester activity given the block template and containing process. Returns requester activity.

Supported API: false

Parameters:

template -

container -

Returns:

WfRequesterActivity

Throws:

WTException

createStartAdHocProcess

public WfContainer createStartAdHocProcess(WfAdHocActivity requester,
                                           WfContainerTemplate template)
                                    throws WTException

Creates and starts an adh hoc process given the ad hoc activity and the template from which the process should be instantiated. The template can be either a process or a block template. Returns the running process.

Supported API: true

Parameters:

requester -

template -

Returns:

WfContainer

Throws:

WTException

startProcess

public WfProcess startProcess(WfProcess process,
                              ProcessData input,
                              long priority,
                              Timestamp start_time,
                              Timestamp deadline)
                       throws WTException

Start a process given, in addition to the input data, absolute start time and deadline. The values provided (if not null) supersede the default values calculated using the process template. If any of the values is null then the corresponding default value is used.

Supported API: true

Parameters:

process -

input -

priority -

start_time -

deadline -

Returns:

WfProcess

Throws:

WTException

getResponsible

public WTPrincipal getResponsible(WfExecutionObject exec_obj)
                           throws WTException

Returns principal responsible for the execution object. First tries to resolve responsibleRole; if this is null, gets the responsible for the host process. Failing these, it returns the principal of the process creator. If more than one principal is resolved for the responsibleRole, it returns the first role.

Supported API: true

Parameters:

exec_obj -

Returns:

WTPrincipal

Throws:

WTException

getAssociatedProcesses

public Enumeration getAssociatedProcesses(Persistable object,
                                          WfState state)
                                   throws WTException

Deprecated. use method with WTContainerRef argument.

Returns all process instances associated with the object passed as argument that are in a given state. If state is null, all process instances are returned, irrespective of the state.

Supported API: true

Parameters:

object -

state -

Returns:

Enumeration

Throws:

WTException

createAdHocProcess

public WfProcess createAdHocProcess(WfTemplateObject template,
                                    Object team_spec)
                             throws WTException

Deprecated. use method with WTContainerRef

Creates a process given a template object that can be a process template, a block template or an activity template. If it is a process template, the createProcess method is called; if it is an activity template, a block template is generated and the process generated from it; finally, if it is a block template, the process is generated directly from the block template.

In case it is an activity template, the block template generated has the same name as the activity template as well as variables. The mapping between the block templates and activity templates is a 1-1 mapping based on the variable names. This has the effect that the block template is completely transparent during execution time.

A team specification can be one of the following:

• RoleHolder (deprecated)
• wt.team.TeamRef
• wt.team.TeamTeamplateRef
• LifeCycleManaged

  Import Note: The process will be created in the same WTContainer as the team spec passed as argument, except in the case the team spec is a wt.team.TeamTeamplateRef, in which case the process is created in the classic container. There is a similar method with the same name that accepts an additional argument that is a reference to the container where the process is to be created.
  
  Supported API: true

  Parameters:

  template -

  team_spec -

  Returns:

  WfProcess

  Throws:

  WTException

getRelatedProcessesURL

public URL getRelatedProcessesURL(WTObject obj)
                           throws WTException

Returns a URL to view associated workflow processes given a business object.

Supported API: true

Parameters:

obj -

Returns:

URL

Throws:

WTException

whereUsed

public Vector whereUsed(ProjectReference project,
                        boolean returnOnlyFirstOccurrence)
                 throws WTException

Returns a vector of references to any defintion objects that use a particular Project object

Supported API: false

Parameters:

project -

returnOnlyFirstOccurrence - this boolean parameter determines whether to return all objects that use the Project object or only the first usage. This parameter was added for performance reasons and the occasional need to only know that the project is used.

Returns:

Vector

Throws:

WTException

getResponsibleParticipants

public Enumeration getResponsibleParticipants(WfExecutionObject exec_obj)
                                       throws WTException

Returns an Enumeration of principal references who are responsible for the execution object. First tries to resolve responsibleRole; if this is null, gets the principal references responsible for the host process. Failing these, it returns the principal reference for the process creator.

Supported API: true

Parameters:

exec_obj -

Returns:

Enumeration

Throws:

WTException

terminateObjectsRunningWorkflows

public void terminateObjectsRunningWorkflows(Persistable object)
                                      throws WTException

if terminateObjectsRunningWorkflows=true, terminate all the objects running processes.

Supported API: true

Parameters:

object - The object for which you wish to terminate the objects running workflows.

Throws:

WTException

terminateObjectsRunningWorkflows

public void terminateObjectsRunningWorkflows(WTCollection collection)
                                      throws WTException

if terminateObjectsRunningWorkflows=true, terminate all the objects running processes.

Supported API: true

Parameters:

collection - The collection of objects for which you wish to terminate the running workflows.

Throws:

WTException

createProcess

public WfProcess createProcess(WfProcessDefinition template,
                               Object team_spec,
                               WTContainerRef context_ref)
                        throws WTException

Creates and returns a process from the given template, associated team specification and a reference to the context (@link wt.inf.container.WTContainerRef} where the process is to be created. If name is null the process name is the same as the template.

A team specification can be one of the following:

• RoleHolder (deprecated)
• wt.team.TeamRef
• wt.team.TeamTeamplateRef
• LifeCycleManaged
  
  Supported API: true

  Parameters:

  template -

  team_spec -

  context_ref -

  Returns:

  WfProcess

  Throws:

  WTException

createAdHocProcess

public WfProcess createAdHocProcess(WfTemplateObject template,
                                    Object team_spec,
                                    WTContainerRef context_ref)
                             throws WTException

Creates a process given a template object that can be a process template, a block template or an activity template. If it is a process template, the createProcess method is called; if it is an activity template, a block template is generated and the process generated from it; finally, if it is a block template, the process is generated directly from the block template.

In case it is an activity template, the block template generated has the same name as the activity template as well as variables. The mapping between the block templates and activity templates is a 1-1 mapping based on the variable names. This has the effect that the block template is completely transparent during execution time.

Supported API: true

Parameters:

template -

team_spec -

context_ref -

Returns:

WfProcess

Throws:

WTException

whereUsed

public Vector whereUsed(TeamTemplateReference teamTemplateRef,
                        boolean returnOnlyFirstOccurrence)
                 throws WTException

Returns a vector of references to any defintion objects that use a particular TeamTemplate object

Supported API: false

Parameters:

teamTemplateRef -

returnOnlyFirstOccurrence - this boolean parameter determines whether to return all objects that use the TeamTemplate object or only the first usage. This parameter was added for performance reasons and the occasional need to only know that the team template is used.

Returns:

Vector

Throws:

WTException

whereUsed

public Vector whereUsed(TeamReference teamRef,
                        boolean returnOnlyFirstOccurrence)
                 throws WTException

Returns a vector of references to any defintion objects that use a particular Team object

Supported API: false

Parameters:

teamRef -

returnOnlyFirstOccurrence - this boolean parameter determines whether to return all objects that use the Team object or only the first usage. This parameter was added for performance reasons and the occasional need to only know that the team is used.

Returns:

Vector

Throws:

WTException

getTeamName

public String getTeamName(WfContainer container)
                   throws WTException

Returns the name of the team associated with the given process. If there is none (as it can be the case of robot activities) then the method returns 'null'.

Supported API: true

Parameters:

container -

Returns:

String

Throws:

WTException

getAssociatedProcesses

public QueryResult getAssociatedProcesses(Persistable object,
                                          WfState state,
                                          WTContainerRef context_ref)
                                   throws WTException

Returns all process instances associated with the object passed as argument that are in a given state in the passed WTContainer. If state is null, all process instances are returned, irrespective of the state.

Supported API: true

Parameters:

object -

state -

context_ref -

Returns:

QueryResult

Throws:

WTException

getOverdueProcesses

public QueryResult getOverdueProcesses(WTContainerRef context_ref)
                                throws WTException

Returns all overdue processes in a given WTContainer. An overdue process is one that its deadline has passed.

Supported API: true

Parameters:

context_ref -

Returns:

QueryResult

Throws:

WTException

getProcesses

public QueryResult getProcesses(WfState state,
                                WTContainerRef context_ref)
                         throws WTException

Returns all existing processes in a given state and WTContainer. For example, one can ask for all OPEN processes (irrespective of its substates). If state is null all processes are returned irrespective of their states.

Supported API: false

Parameters:

state -

context_ref -

Returns:

QueryResult

Throws:

WTException

getWfFolder

public Folder getWfFolder(String folder_path,
                          WTObject pbo,
                          WTContainerRef context_ref)
                   throws WTException

Gets folder given its relative path, associated business object and the context. If folder doesn't exit it is created. The business object may be null but assumes context reference is not null.

Creates workflow folder for a given context. The folder path is also passed as argument. Assumes folder_path of the form:

 /System/Workflows/
 

where forder-name is one of {"NotStarted", "Running", ...}

The folder is created as /System/Workflows/, where is the context's default cabinet.

Supported API: true

Parameters:

folder_path -

pbo -

context_ref -

Returns:

Folder

Throws:

WTException

getWfFolder

public Folder getWfFolder(String folder_name)
                   throws WTException

Deprecated. use method with the same name with two additional parameters: the primary business object and the container of the process.

Supported API: false

Parameters:

folder_name -

Returns:

Folder

Throws:

WTException

createProcesses

public WTValuedMap createProcesses(WTValuedMap objToWfDefMap,
                                   WTKeyedMap objToWfNameMap,
                                   WTCollection collection,
                                   boolean setTeamFromPbo,
                                   long priority)
                            throws WTException

Creates and returns a WTValuedMap of objects to WfProcess.

Supported API: false

Parameters:

objToWfDefMap - Object to WfProcessDefinition map

objToWfNameMap - Object to Workflow Process name map.

collection - Collection of target objects

setTeamFromPbo - set TeamTemplate from target object

priority - WfProcess priority value

Returns:

WTValuedMap

Throws:

WTException

createProcesses

public WTValuedMap createProcesses(WTValuedMap objToWfDefMap,
                                   WTKeyedMap objToWfNameMap,
                                   WTCollection collection,
                                   boolean setTeamFromPbo,
                                   long priority,
                                   WTContainerRef context_ref)
                            throws WTException

Creates and returns a WTValuedMap of objects to WfProcess.

Supported API: false

Parameters:

objToWfDefMap - Object to WfProcessDefinition map

objToWfNameMap - Object to Workflow Process name map.

collection - Collection of target objects

setTeamFromPbo - set TeamTemplate from target object

priority - WfProcess priority value

context_ref - WTContainerRef to be used for newly created Workflow Processes.

Returns:

WTValuedMap

Throws:

WTException

startProcesses

public WTCollection startProcesses(WTCollection processes)
                            throws WTException

Queues the start of all WfProcess objects in the given WTCollection. Returns the collection of WfProcess objects.

Supported API: false

Parameters:

processes - collection of WfProcess objects

Returns:

WTCollection

Throws:

WTException

getAssignmentEvents

public WTCollection getAssignmentEvents(WfProcess process,
                                        Role role,
                                        WTPrincipalReference new_assignee_ref,
                                        WTPrincipalReference old_assignee_ref,
                                        WTReference bus_obj_ref)
                                 throws WTException

Returns all the reassignment events for the process, role, old assignee, new assignee and business object passed as argument. It is expected that the execution object be an assigned activity or a process (other than that an empty collection is returned). Any number of arguments may be null, in which case the null argument is ignored in the query.

Note

The business object is passed as argument as a WTReference, which can be an ObjectReference or a wt.fc.VersionReference. In case of Iterated objects a wt.fc.VersionReference needs to be passed as argument, otherwise the events will not be found.

Supported API: false

Parameters:

process -

role -

new_assignee_ref -

old_assignee_ref -

bus_obj_ref -

Returns:

WTCollection

Throws:

WTException

getVotingEvents

public WTCollection getVotingEvents(WfProcess process,
                                    Role role,
                                    WTPrincipalReference user_ref,
                                    WTReference bus_obj_ref)
                             throws WTException

Returns all the voting events for the process, role, assignee and business object passed as argument. It is expected that the execution object be an assigned activity or a process (other than that an empty collection is returned). Any number of arguments may be null, in which case the null argument is ignored in the query.

Note

The business object is passed as argument as a WTReference, which can be an ObjectReference or a wt.fc.VersionReference. In case of Iterated objects a wt.fc.VersionReference needs to be passed as argument, otherwise the events will not be found.

Supported API: false

Parameters:

process -

role -

user_ref -

bus_obj_ref -

Returns:

WTCollection

Throws:

WTException

getDataEvents

public WTCollection getDataEvents(WfExecutionObject exec_obj,
                                  Role role,
                                  WTPrincipalReference user_ref,
                                  WTReference bus_obj_ref)
                           throws WTException

Returns all the data events for the execution object (process or activity), role, assignee, and business object passed as arguments. Any number of arguments except the execution object may be null, in which case the null argument is ignored in the query. The WTReference passed as argument is either an ObjectReference (for non-iterated objects) or a VersionReference if the business object is iterated. Note: The API is the same both for process and activity variables. If the execution object passed as argument is a process, the method returns process variable updates, otherwise, if it is an activity, it returns activity variable updates.

Supported API: false

Parameters:

exec_obj -

role -

user_ref -

bus_obj_ref -

Returns:

WTCollection

Throws:

WTException

getProcessNodeDueDates

public HashMap getProcessNodeDueDates(WfProcess process)
                               throws WTException

Returns a HashMap. The key being an ObjectReference of either a WfAssignedActifvityTemplate(if the activity has yet to be instantiated) or a WfAssignedActivity. The value is the WfDueDate object associatedwith this activity.

Supported API: false

Parameters:

process -

Returns:

HashMap

Throws:

WTException

setProcessNodeDueDates

public void setProcessNodeDueDates(ObjectReference process,
                                   HashMap hash)
                            throws WTException

Takes an ObjectReference to a process and a HashMap of ObjectReference->WfDueDate paris. The key if the HashMap is an ObjectReference of either a WfAssignedActivityTemplate (if the activity has yet to be instantiated) or a WfAssignedActivity. The value is the WfDueDate object associated with this activity. Returns a HashMap. The key being a WfAssignedActifvityTemplate's ObjectReference. The value is the WfDueDate object associatedwith this activity.

Supported API: false

Parameters:

process -

hash -

Throws:

WTException

getProcessNodeInstructions

public HashMap getProcessNodeInstructions(WfProcess process)
                                   throws WTException

Returns a HashMap. The key being an ObjectReference of either a WfAssignedActifvityTemplate(if the activity has yet to be instantiated) or a WfAssignedActivity. The value is the WfInstruction object associatedwith this activity.

Supported API: false

Parameters:

process -

Returns:

HashMap

Throws:

WTException

getProcessNodeInstructions

public HashMap getProcessNodeInstructions(WfProcessTemplate processTemplate)
                                   throws WTException

Returns a HashMap. The key being an ObjectReference of a WfAssignedActifvityTemplate. The value is the WfInstruction object associatedwith this activity.

Supported API: false

Parameters:

processTemplate -

Returns:

HashMap

Throws:

WTException

setProcessNodeInstructions

public void setProcessNodeInstructions(ObjectReference process,
                                       HashMap hash)
                                throws WTException

Takes an ObjectReference to a process and a HashMap of ObjectReference->WfInstructions pairs. The key if the HashMap is an ObjectReference of either a WfAssignedActivityTemplate (if the activity has yet to be instantiated) or a WfAssignedActivity. The value is the WfInstruction object associated with this activity.

Supported API: false

Parameters:

process -

hash -

Throws:

WTException

getWfDomain

public AdminDomainRef getWfDomain(WTObject pbo,
                                  WTContainerRef context_ref)
                           throws WTException

Gets the AdminDomainRef given the associated business object and the context. The business object may be null, but assumes context reference is not null.

Supported API: false

Parameters:

pbo -

context_ref -

Returns:

AdminDomainRef

Throws:

WTException

getProcessNodeDurations

public HashMap getProcessNodeDurations(WfProcessTemplate pt)
                                throws WTException

Returns a HashMap. The key being a WfAssignedActifvityTemplate's ObjectReference. The value is the WfDuration object associatedwith this activity.

Supported API: false

Parameters:

pt -

Returns:

HashMap

Throws:

WTException

getProcessNodeDurations

public HashMap getProcessNodeDurations(WfProcess process)
                                throws WTException

Returns a HashMap. The key being an ObjectReference of either a WfAssignedActifvityTemplate(if the activity has yet to be instantiated) or a WfAssignedActivity. The value is the WfDuration object associatedwith this activity.

Supported API: false

Parameters:

process -

Returns:

HashMap

Throws:

WTException

getProcessNodeNotifications

public HashMap getProcessNodeNotifications(WfProcessTemplate pt)
                                    throws WTException

Returns a HashMap. The key being a WfAssignedActifvityTemplate's ObjectReference. The value is the WfAssigneeNotificationobject associatedwith this activity.

Supported API: false

Parameters:

pt -

Returns:

HashMap

Throws:

WTException

getProcessNodeNotifications

public HashMap getProcessNodeNotifications(WfProcess process)
                                    throws WTException

Returns a HashMap. The key being an ObjectReference of either a WfAssignedActifvityTemplate(if the activity has yet to be instantiated) or a WfAssignedActivity. The value is the WfAssigneeNotification object associatedwith this activity.

Supported API: false

Parameters:

process -

Returns:

HashMap

Throws:

WTException

setProcessNodeDurations

public void setProcessNodeDurations(ObjectReference process,
                                    HashMap hash)
                             throws WTException

Takes an ObjectReference to a process and a HashMap of ObjectReference->WfDuration paris. The key if the HashMap is an ObjectReference of either a WfAssignedActivityTemplate (if the activity has yet to be instantiated) or a WfAssignedActivity. The value is the WfDuration object associated with this activity. Returns a HashMap. The key being a WfAssignedActifvityTemplate's ObjectReference. The value is the WfDuration object associatedwith this activity.

Supported API: false

Parameters:

process -

hash -

Throws:

WTException

setProcessNodeNotifications

public void setProcessNodeNotifications(ObjectReference process,
                                        HashMap hash)
                                 throws WTException

Takes an ObjectReference to a process and a HashMap of ObjectReference->WfAssigneeNotification paris. The key if the HashMap is an ObjectReference of either a WfAssignedActivityTemplate (if the activity has yet to be instantiated) or a WfAssignedActivity. The value is the WfAssigneeNotification object associated with this activity. Returns a HashMap. The key being a WfAssignedActifvityTemplate's ObjectReference. The value is the WfAssigneeNotification object associatedwith this activity.

Supported API: false

Parameters:

process -

hash -

Throws:

WTException