ProcessInstance - BETA ActionScript® 3 (AS3 ADEP Document Services) Reference for the Adobe® Flash® Platform API Reference

(Beta)

Package	lc.procmgmt.domain
Class	public class ProcessInstance
Inheritance	ProcessInstance Object
Implements	IManagedObject, IManaged

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Experience Services - Document Services ES2

Runtime Versions:

AIR 1.0, Flash Player 9, Flash Player 10

The ProcessInstance class represents a process instance in LiveCycle ES2. A ProcessInstance object is used for the following purposes:

Retrieving the properties of the process instance

Loading tasks, pending tasks, and process variables that belong to the process instance

Public Properties

Hide Inherited Public Properties

Show Inherited Public Properties

	Property		Defined By
		constructor : Object A reference to the class object or constructor function for a given object instance.	Object
		description : String The description of the process instance.	ProcessInstance
		imageUrl : String The location of an image for the process instance.	ProcessInstance
		initiator : String The initiator of the process instance.	ProcessInstance
		initiatorId : String The identifier of the initiator who started the process instance.	ProcessInstance
		pendingTasks : ListCollectionView The collection of pending tasks for the process instance.	ProcessInstance
		processCompleteTime : Date The date and time that the process instance completed.	ProcessInstance
		processInstanceId : Number The unique identifier of the process instance.	ProcessInstance
		processInstanceStatus : Number The status number of the process instance.	ProcessInstance
		processName : String The name of the process, with which this process instance is associated.	ProcessInstance
		processStartTime : Date The date and time of the process instance started.	ProcessInstance
		processVariables : ListCollectionView The collection of process variables for the process instance.	ProcessInstance
		session : SessionMap [read-only] A SessionMap object that stores information relating to the server session.	ProcessInstance
		tasks : ListCollectionView The collection of tasks for the process instance.	ProcessInstance

Public Methods

Hide Inherited Public Methods

Show Inherited Public Methods

	Method		Defined By
		addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, weakRef:Boolean = false):void Registers an event listener object with an EventDispatcher object so that the listener receives notification of an event.	ProcessInstance
		dispatchEvent(event:Event):Boolean Dispatches an event into the event flow.	ProcessInstance
		hasEventListener(type:String):Boolean Checks whether the EventDispatcher object has any listeners registered for a specific type of event.	ProcessInstance
		hasOwnProperty(name:String):Boolean Indicates whether an object has a specified property defined.	Object
		isPrototypeOf(theClass:Object):Boolean Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.	Object
		loadPendingTasks(forceLoad:Boolean = false):lc.foundation.util:Token Loads the pending tasks for the process instances.	ProcessInstance
		loadProcessVariables(forceLoad:Boolean = false):lc.foundation.util:Token Loads the process variables for the process instance.	ProcessInstance
		loadTasks(forceLoad:Boolean = false):lc.foundation.util:Token Loads the tasks for the process instances.	ProcessInstance
		propertyIsEnumerable(name:String):Boolean Indicates whether the specified property exists and is enumerable.	Object
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void Removes a listener from the EventDispatcher object.	ProcessInstance
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Sets the availability of a dynamic property for loop operations.	Object
		setSession(session:SessionMap):void Sets a SessionMap object that stores the information relating to the server session.	ProcessInstance
		toLocaleString():String Returns the string representation of this object, formatted according to locale-specific conventions.	Object
		toString():String Returns the string representation of the specified object.	Object
		valueOf():Object Returns the primitive value of the specified object.	Object
		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.	ProcessInstance

Property Detail

description

property

description:String

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Experience Services - Document Services ES2

Runtime Versions:

AIR 1.0, Flash Player 9, Flash Player 10

The description of the process instance.

This property can be used as the source for data binding. When this property is modified, it dispatches the propertyChange event.

Implementation
public function get description():String
public function set description(value:String):void

imageUrl

property

imageUrl:String

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Experience Services - Document Services ES2

Runtime Versions:

AIR 1.0, Flash Player 9, Flash Player 10

The location of an image for the process instance. The value is an is a URL.

This property can be used as the source for data binding. When this property is modified, it dispatches the propertyChange event.

Implementation
public function get imageUrl():String
public function set imageUrl(value:String):void

initiator

property

initiator:String

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Experience Services - Document Services ES2

Runtime Versions:

AIR 1.0, Flash Player 9, Flash Player 10

The initiator of the process instance.

This property can be used as the source for data binding. When this property is modified, it dispatches the propertyChange event.

Implementation
public function get initiator():String
public function set initiator(value:String):void

initiatorId

property

initiatorId:String

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Experience Services - Document Services ES2

Runtime Versions:

AIR 1.0, Flash Player 9, Flash Player 10

The identifier of the initiator who started the process instance.

This property can be used as the source for data binding. When this property is modified, it dispatches the propertyChange event.

Implementation
public function get initiatorId():String
public function set initiatorId(value:String):void

pendingTasks

property

pendingTasks:ListCollectionView

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Experience Services - Document Services ES2

Runtime Versions:

AIR 1.0, Flash Player 9, Flash Player 10

The collection of pending tasks for the process instance.

This property can be used as the source for data binding. When this property is modified, it dispatches the propertyChange event.

Implementation
public function get pendingTasks():ListCollectionView
public function set pendingTasks(value:ListCollectionView):void

processCompleteTime

property

processCompleteTime:Date

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Experience Services - Document Services ES2

Runtime Versions:

AIR 1.0, Flash Player 9, Flash Player 10

The date and time that the process instance completed.

This property can be used as the source for data binding. When this property is modified, it dispatches the propertyChange event.

Implementation
public function get processCompleteTime():Date
public function set processCompleteTime(value:Date):void

processInstanceId

property

processInstanceId:Number

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Experience Services - Document Services ES2

Runtime Versions:

AIR 1.0, Flash Player 9, Flash Player 10

The unique identifier of the process instance.

This property can be used as the source for data binding. When this property is modified, it dispatches the propertyChange event.

Implementation
public function get processInstanceId():Number
public function set processInstanceId(value:Number):void

processInstanceStatus

property

processInstanceStatus:Number

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Experience Services - Document Services ES2

Runtime Versions:

AIR 1.0, Flash Player 9, Flash Player 10

The status number of the process instance.

The process instance's status value is a localized String value that is processed by performing a look-up of the numeric value in the resource bundle.

This property can be used as the source for data binding. When this property is modified, it dispatches the propertyChange event.

Implementation
public function get processInstanceStatus():Number
public function set processInstanceStatus(value:Number):void

Related API Elements

lc.procmgmt.ProcessConstants

processName

property

processName:String

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Experience Services - Document Services ES2

Runtime Versions:

AIR 1.0, Flash Player 9, Flash Player 10

The name of the process, with which this process instance is associated.

This property can be used as the source for data binding. When this property is modified, it dispatches the propertyChange event.

Implementation
public function get processName():String
public function set processName(value:String):void

processStartTime

property

processStartTime:Date

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Experience Services - Document Services ES2

Runtime Versions:

AIR 1.0, Flash Player 9, Flash Player 10

The date and time of the process instance started.

This property can be used as the source for data binding. When this property is modified, it dispatches the propertyChange event.

Implementation
public function get processStartTime():Date
public function set processStartTime(value:Date):void

processVariables

property

processVariables:ListCollectionView

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Experience Services - Document Services ES2

Runtime Versions:

AIR 1.0, Flash Player 9, Flash Player 10

The collection of process variables for the process instance.

This property can be used as the source for data binding. When this property is modified, it dispatches the propertyChange event.

Implementation
public function get processVariables():ListCollectionView
public function set processVariables(value:ListCollectionView):void

session

property

session:SessionMap [read-only]

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Experience Services - Document Services ES2

Runtime Versions:

AIR 1.0, Flash Player 9, Flash Player 10

A SessionMap object that stores information relating to the server session.

Implementation
public function get session():SessionMap

tasks

property

tasks:ListCollectionView

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Experience Services - Document Services ES2

Runtime Versions:

AIR 1.0, Flash Player 9, Flash Player 10

The collection of tasks for the process instance.

This property can be used as the source for data binding. When this property is modified, it dispatches the propertyChange event.

Implementation
public function get tasks():ListCollectionView
public function set tasks(value:ListCollectionView):void

Method Detail

addEventListener

()

method

 public function addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, weakRef:Boolean = false):void

Registers an event listener object with an EventDispatcher object so that the listener receives notification of an event. You can register event listeners on all nodes in the display list for a specific type of event, phase, and priority.

After you successfully register an event listener, you cannot change its priority through additional calls to addEventListener(). To change a listener's priority, you must first call removeEventListener(). Then you can register the listener again with the new priority level.

After the listener is registered, subsequent calls to addEventListener() with a different value for either type or useCapture result in the creation of a separate listener registration. For example, if you first register a listener with useCapture set to true, it listens only during the capture phase. If you call addEventListener() again using the same listener object, but with useCapture set to false, you have two separate listeners: one that listens during the capture phase, and another that listens during the target and bubbling phases.

You cannot register an event listener for only the target phase or the bubbling phase. Those phases are coupled during registration because bubbling applies only to the ancestors of the target node.

When you no longer need an event listener, remove it by calling EventDispatcher.removeEventListener(); otherwise, memory problems might result. Objects with registered event listeners are not automatically removed from memory because the garbage collector does not remove objects that still have references.

Copying an EventDispatcher instance does not copy the event listeners attached to it. (If your newly created node needs an event listener, you must attach the listener after creating the node.) However, if you move an EventDispatcher instance, the event listeners attached to it move along with it.

If the event listener is being registered on a node while an event is also being processed on this node, the event listener is not triggered during the current phase but may be triggered during a later phase in the event flow, such as the bubbling phase.

If an event listener is removed from a node while an event is being processed on the node, it is still triggered by the current actions. After it is removed, the event listener is never invoked again (unless it is registered again for future processing).

Parameters

	`type:String` — The type of event.

	`listener:Function` — The listener function that processes the event. This function must accept an event object as its only parameter and must return nothing, as this example shows: `function(evt:Event):void` The function can have any name.

	`useCapture:Boolean` (default = `false`) — Determines whether the listener works in the capture phase or the target and bubbling phases. If `useCapture` is set to `true`, the listener processes the event only during the capture phase and not in the target or bubbling phase. If `useCapture` is `false`, the listener processes the event only during the target or bubbling phase. To listen for the event in all three phases, call `addEventListener()` twice, once with `useCapture` set to `true`, then again with `useCapture` set to `false`.

	`priority:int` (default = `0`) — The priority level of the event listener. Priorities are designated by a 32-bit integer. The higher the number, the higher the priority. All listeners with priority n are processed before listeners of priority n-1. If two or more listeners share the same priority, they are processed in the order in which they were added. The default priority is 0.

	`weakRef:Boolean` (default = `false`) — Determines whether the reference to the listener is strong or weak. A strong reference (the default) prevents your listener from being garbage-collected. A weak reference does not. Class-level member functions are not subject to garbage collection, so you can set `useWeakReference` to `true` for class-level member functions without subjecting them to garbage collection. If you set `useWeakReference` to `true` for a listener that is a nested inner function, the function will be garbge-collected and no longer persistent. If you create references to the inner function (save it in another variable) then it is not garbage-collected and stays persistent.

dispatchEvent

()

method

public function dispatchEvent(event:Event):Boolean

Dispatches an event into the event flow. The event target is the EventDispatcher object upon which dispatchEvent() is called.

Parameters

event:Event — The event object dispatched into the event flow.

Returns

Boolean — A value of true unless preventDefault() is called on the event, in which case it returns false.

hasEventListener

()

method

public function hasEventListener(type:String):Boolean

Checks whether the EventDispatcher object has any listeners registered for a specific type of event. This allows you to determine where an EventDispatcher object has altered handling of an event type in the event flow hierarchy. To determine whether a specific event type will actually trigger an event listener, use IEventDispatcher.willTrigger().

The difference between hasEventListener() and willTrigger() is that hasEventListener() examines only the object to which it belongs, whereas willTrigger() examines the entire event flow for the event specified by the type parameter.

Parameters

type:String — The type of event.

Returns

Boolean — A value of true if a listener of the specified type is registered; false otherwise.

loadPendingTasks

()

method

public function loadPendingTasks(forceLoad:Boolean = false):lc.foundation.util:Token

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Experience Services - Document Services ES2

Runtime Versions:

AIR 1.0, Flash Player 9, Flash Player 10

Loads the pending tasks for the process instances.

Parameters

forceLoad:Boolean (default = false) — Specifies to force-load the pending tasks when a value of true is provided.

Returns

lc.foundation.util:Token — An object that is used to specify handlers for this asynchronous call.

loadProcessVariables

()

method

public function loadProcessVariables(forceLoad:Boolean = false):lc.foundation.util:Token

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Experience Services - Document Services ES2

Runtime Versions:

AIR 1.0, Flash Player 9, Flash Player 10

Loads the process variables for the process instance.

Parameters

forceLoad:Boolean (default = false) — Specifies to force load the process variables when a value of true is provided.

Returns

lc.foundation.util:Token — An object that is used to specify handlers for this asynchronous call.

loadTasks

()

method

public function loadTasks(forceLoad:Boolean = false):lc.foundation.util:Token

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Experience Services - Document Services ES2

Runtime Versions:

AIR 1.0, Flash Player 9, Flash Player 10

Loads the tasks for the process instances.

Parameters

forceLoad:Boolean (default = false) — Specifies to force-load the tasks when a value of true is provided.

Returns

lc.foundation.util:Token — An object is used to specify handlers for this asynchronous call.

removeEventListener

()

method

public function removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void

Removes a listener from the EventDispatcher object. If there is no matching listener registered with the EventDispatcher object, a call to this method has no effect.

Parameters

	`type:String` — The type of event.

	`listener:Function` — The listener object to remove.

	`useCapture:Boolean` (default = `false`) — Specifies whether the listener was registered for the capture phase or the target and bubbling phases. If the listener was registered for both the capture phase and the target and bubbling phases, two calls to `removeEventListener()` are required to remove both: one call with `useCapture` set to `true`, and another call with `useCapture` set to `false`.

setSession

()

method

public function setSession(session:SessionMap):void

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Experience Services - Document Services ES2

Runtime Versions:

AIR 1.0, Flash Player 9, Flash Player 10

Sets a SessionMap object that stores the information relating to the server session.

Parameters

session:SessionMap — Specifies the information relating to the server session.

willTrigger

()

method

public function 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. This method returns true if an event listener is triggered during any phase of the event flow when an event of the specified type is dispatched to this EventDispatcher object or any of its descendants.

Parameters

type:String — The type of event.

Returns

Boolean — A value of true if a listener of the specified type will be triggered; false otherwise.

[an error occurred while processing this directive]

Legal Notices | Online Privacy Policy

ProcessInstance - AS3 ADEP Document Services

Classes x

description

imageUrl

initiator

initiatorId

pendingTasks

processCompleteTime

processInstanceId

processInstanceStatus

processName

processStartTime

processVariables

session

tasks

addEventListener

dispatchEvent

hasEventListener

loadPendingTasks

loadProcessVariables

loadTasks

removeEventListener

setSession

willTrigger