Packagelc.core
Interfacepublic interface IProcessManager

The IProcessManager interface is implemented to determine the list of processes that the user has participated in.

You implement the IProcessManager interface to retrieve a list of processes that a user would participate in.


Public Methods
 MethodDefined By
  
findProcessInstances(processName:String, startDate:Date = null, endDate:Date = null):CollectionToken
Retrieves a collection of process instances for a given process name that the user has participated in.
IProcessManager
  
getProcesses():CollectionToken
Retrieves a unique list of processes that the user has participated in.
IProcessManager
  
getProcessImageUrl(processName:String):String
Retrieves the location of the process image identified by the process instance identifier.
IProcessManager
  
getProcessInstance(processInstanceId:Number, serviceName:String = null):ObjectToken
Retrieves the process instance identified by the process instance identifier.
IProcessManager
  
getProcessVariableDefinitions(processName:String):CollectionToken
Retrieves a collection of process variable definitions for a given process name that the user has participated in.
IProcessManager
  
getProcessVariablesForProcessInstance(processName:String, processInstanceId:Number):CollectionToken
Retrieves a collection of process variables for the identified process name and process identifier.
IProcessManager
  
getProcessVariablesForQueueFilter(processName:String, queueId:Number, activeTasks:Boolean = true):CollectionToken
Retrieves a collection of process variables for the identified process name and process identifier.
IProcessManager
Method Detail
findProcessInstances()method
public function findProcessInstances(processName:String, startDate:Date = null, endDate:Date = null):CollectionToken

Retrieves a collection of process instances for a given process name that the user has participated in. If the process start date and end date are supplied, the process instances are restricted to those that fall in this date range.

Parameters

processName:String — Specifies the name of the process to get the process instances for.
 
startDate:Date (default = null) — Specifies the starting date of the range.
 
endDate:Date (default = null) — Specifies the ending date of the range.

Returns
CollectionToken — A token containing a collection of ProcessInstance objects when the request completes. You can set result and fault handlers on the token to be called when the invocation is complete and the collection is fully populated.
getProcesses()method 
public function getProcesses():CollectionToken

Retrieves a unique list of processes that the user has participated in.

Returns
CollectionToken — A token containing a collection of Process objects when the request completes. You can set result and fault handlers on the token to be called when the invocation is complete and the collection is fully populated.
getProcessImageUrl()method 
public function getProcessImageUrl(processName:String):String

Retrieves the location of the process image identified by the process instance identifier.

Parameters

processName:String — Specifies the identifier of the process instance.

Returns
String — The location of the image as a URL.
getProcessInstance()method 
public function getProcessInstance(processInstanceId:Number, serviceName:String = null):ObjectToken

Retrieves the process instance identified by the process instance identifier. If the service name is provided, the process variables will be populated in the token.

Parameters

processInstanceId:Number — Specifies the unique identifier of the process instance.
 
serviceName:String (default = null) — Specifies the name of the service.

Returns
ObjectToken — The token representing the process instance.
getProcessVariableDefinitions()method 
public function getProcessVariableDefinitions(processName:String):CollectionToken

Retrieves a collection of process variable definitions for a given process name that the user has participated in.

Parameters

processName:String — Specifies the name of the process to get the process instances for.

Returns
CollectionToken — A token containing a collection of ProcessVariable objects when the request completes. You can set result and fault handlers on the token to be called when the invocation is complete and the collection is fully populated.
getProcessVariablesForProcessInstance()method 
public function getProcessVariablesForProcessInstance(processName:String, processInstanceId:Number):CollectionToken

Retrieves a collection of process variables for the identified process name and process identifier.

Parameters

processName:String — Specifies the name of the process.
 
processInstanceId:Number — Specifies the process instance identifier.

Returns
CollectionToken — A token containing a collection of ProcessVariable objects when the request completes. You can set result and fault handlers on the token to be called when the invocation is complete and the collection is fully populated.
getProcessVariablesForQueueFilter()method 
public function getProcessVariablesForQueueFilter(processName:String, queueId:Number, activeTasks:Boolean = true):CollectionToken

Retrieves a collection of process variables for the identified process name and process identifier.

Parameters

processName:String — Specifies the name of the process.
 
queueId:Number — Specifies the queue identifier.
 
activeTasks:Boolean (default = true) — Specifies whether to retrieve only active tasks. A value of true specifies retrieve only tasks that are active for the user.

Returns
CollectionToken — A collection of ProcessVariable objects when the request completes. You can set result and fault handlers on the token to be called when the invocation is complete and the collection is fully populated.



© 2004-2007 Adobe Systems Incorporated. All rights reserved.
Sun Sep 23 2007, 10:15 PM GMT-07:00

 

Send me an e-mail when comments are added to this page | Comment Report

Current page: http://livedocs.adobe.com/livecycle/es/sdkHelp/common/langref/lc/core/IProcessManager.html