IProcessManager

Package	lc.procmgmt
Interface	public interface IProcessManager extends IManager , IEventDispatcher

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Document Services - Workspace 9

Runtime Versions:

AIR (unsupported), Flash Player 9, Flash Player 10

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

Public Properties

	Property		Defined By
		faultHandler : Function The default fault handler function.	IManager

Public Methods

	Method		Defined By
		addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void Registers an event listener object with an EventDispatcher object so that the listener receives notification of an event.	IEventDispatcher
		dispatchEvent(event:Event):Boolean Dispatches an event into the event flow.	IEventDispatcher
		findProcessInstances(processName:String, startDate:Date = null, endDate:Date = null):lc.foundation.util:CollectionToken Retrieves a collection of process instances when provided the name of a process that the user has participated in.	IProcessManager
		getAllProcesses():lc.foundation.util:CollectionToken Retrieves a unique list of unique process names for the processes available.	IProcessManager
		getImageUrlForProcess(process:Process):String Retrieves the location of the process image identified by the process.	IProcessManager
		getImageUrlForProcessInstance(processInstance:ProcessInstance):String Retrieves the location of the process instance image identified by the process instance.	IProcessManager
		getProcesses():lc.foundation.util:CollectionToken Retrieves a list of processes that the user has participated in.	IProcessManager
		getProcessImageUrl(processName:String):String Deprecated Since LiveCycle ES Update 1 (8.2): Please use getImageUrlForProcess.	IProcessManager
		getProcessInstance(processInstanceId:Number, serviceName:String = null):lc.foundation.util:ObjectToken Retrieves the process instance identified by the process instance identifier.	IProcessManager
		getProcessVariableDefinitions(processName:String, includeCommonVariables:Boolean, includeSearchable:Boolean):lc.foundation.util:CollectionToken Retrieves a collection of process variable definitions for a process name that the user has participated in.	IProcessManager
		getProcessVariablesForProcessesByQueue(processNames:IList, queueId:Number, activeTasks:Boolean = true):lc.foundation.util:CollectionToken Retrieves a collection of tasks containing only process variables for the identified process names and queue identifier.	IProcessManager
		getProcessVariablesForProcessInstance(processName:String, processInstanceId:Number):lc.foundation.util:CollectionToken Retrieves a collection of process variables for the identified process name and process identifier.	IProcessManager
		getProcessVariablesForQueueFilter(processName:String, queueId:Number, activeTasks:Boolean = true):lc.foundation.util:CollectionToken Retrieves a collection of tasks containing only process variables for the identified process name and queue id.	IProcessManager
		handleEvent(token:lc.foundation.util:Token, event:LiveCycleEvent):void Determines whether the default operation is prevented.	IManager
		handleFault(token:lc.foundation.util:Token, event:LiveCycleFaultEvent):void Determines whether the default operation is prevented.	IManager
		hasEventListener(type:String):Boolean Checks whether the EventDispatcher object has any listeners registered for a specific type of event.	IEventDispatcher
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void Removes a listener from the EventDispatcher object.	IEventDispatcher
		willTrigger(type:String):Boolean Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type.	IEventDispatcher

Method Detail

findProcessInstances

()

method

 public function findProcessInstances(processName:String, startDate:Date = null, endDate:Date = null):lc.foundation.util:CollectionToken

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Document Services - Workspace 9

Runtime Versions:

AIR (unsupported), Flash Player 9, Flash Player 10

Retrieves a collection of process instances when provided the name of a process that the user has participated in. The process instances within a time period are provided when a start date and end date are supplied.

Parameters

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

	`startDate:Date` (default = `null`) — Specifies the start date for filtering process instances.

	`endDate:Date` (default = `null`) — Specifies the end date for filtering process instances.

Returns

lc.foundation.util:CollectionToken — A token object that contains 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 populated with the process instances.

getAllProcesses

()

method

public function getAllProcesses():lc.foundation.util:CollectionToken

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Document Services - Workspace 9

Runtime Versions:

AIR (unsupported), Flash Player 9, Flash Player 10

Retrieves a unique list of unique process names for the processes available.

Returns

lc.foundation.util:CollectionToken — A token that contains a collection of ProcessItem 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.

getImageUrlForProcess

()

method

public function getImageUrlForProcess(process:Process):String

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Document Services - Workspace 9

Runtime Versions:

AIR (unsupported), Flash Player 9, Flash Player 10

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

Parameters

process:Process — Specifies the process to get the location of the image for.

Returns

String — The location of the image as a URL.

getImageUrlForProcessInstance

()

method

public function getImageUrlForProcessInstance(processInstance:ProcessInstance):String

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Document Services - Workspace 9

Runtime Versions:

AIR (unsupported), Flash Player 9, Flash Player 10

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

Parameters

processInstance:ProcessInstance — Specifies the process instance to retrieve a URL for.

Returns

String — The location of the image as a URL.

getProcesses

()

method

public function getProcesses():lc.foundation.util:CollectionToken

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Document Services - Workspace 9

Runtime Versions:

AIR (unsupported), Flash Player 9, Flash Player 10

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

Returns

lc.foundation.util: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

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Document Services - Workspace 9

Runtime Versions:

AIR (unsupported), Flash Player 9, Flash Player 10

Deprecated Since LiveCycle ES Update 1 (8.2): Please use getImageUrlForProcess.

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.

Related API Elements

getImageUrlForProcess()

getProcessInstance

()

method

public function getProcessInstance(processInstanceId:Number, serviceName:String = null):lc.foundation.util:ObjectToken

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Document Services - Workspace 9

Runtime Versions:

AIR (unsupported), Flash Player 9, Flash Player 10

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

lc.foundation.util:ObjectToken — The token representing the process instance.

getProcessVariableDefinitions

()

method

 public function getProcessVariableDefinitions(processName:String, includeCommonVariables:Boolean, includeSearchable:Boolean):lc.foundation.util:CollectionToken

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Document Services - Workspace 9

Runtime Versions:

AIR (unsupported), Flash Player 9, Flash Player 10

Retrieves a collection of process variable definitions for a process name that the user has participated in. It will always return variables with the visible attribute and optionally will return variables that only have the searchable attribute.

Parameters

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

	`includeCommonVariables:Boolean` — Indicator to control inclusion of common process variable definitions in results.

	`includeSearchable:Boolean` — Indicator to control inclusion of searchable only variables the in results.

Returns

lc.foundation.util: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.

getProcessVariablesForProcessesByQueue

()

method

 public function getProcessVariablesForProcessesByQueue(processNames:IList, queueId:Number, activeTasks:Boolean = true):lc.foundation.util:CollectionToken

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Document Services - Workspace 10

Runtime Versions:

AIR (unsupported), Flash Player 9, Flash Player 10

Retrieves a collection of tasks containing only process variables for the identified process names and queue identifier.

Parameters

	`processNames:IList` — Specifies the list of process names.

	`queueId:Number` — Specifies the queue identifier.

	`activeTasks:Boolean` (default = `true`) — Specifies whether to retrieve only active tasks. A value of `true` specifies to retrieve only tasks that are active for the user.

Returns

lc.foundation.util:CollectionToken — A collection of Task 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):lc.foundation.util:CollectionToken

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Document Services - Workspace 9

Runtime Versions:

AIR (unsupported), Flash Player 9, Flash Player 10

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

getProcessVariablesForQueueFilter

()

method

 public function getProcessVariablesForQueueFilter(processName:String, queueId:Number, activeTasks:Boolean = true):lc.foundation.util:CollectionToken

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Document Services - Workspace 9

Runtime Versions:

AIR (unsupported), Flash Player 9, Flash Player 10

Retrieves a collection of tasks containing only process variables for the identified process name and queue id.

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 to retrieve only tasks that are active for the user.

Returns

Legal Notices | Online Privacy Policy

IProcessManager - AS3 ADEP Workspace

Classes x

findProcessInstances

getAllProcesses

getImageUrlForProcess

getImageUrlForProcessInstance

getProcesses

getProcessImageUrl

getProcessInstance

getProcessVariableDefinitions

getProcessVariablesForProcessesByQueue

getProcessVariablesForProcessInstance

getProcessVariablesForQueueFilter