ActionScript® 3.0 Reference for the Adobe® Flash® Platform
Home  |  Show Packages and Classes List |  Packages  |  Classes  |  What's New  |  Index  |  Appendixes
lc.procmgmt.ui.process 

ProcessInstanceInfoModel  - AS3 ADEP Workspace
Packagelc.procmgmt.ui.process
Classpublic class ProcessInstanceInfoModel
InheritanceProcessInstanceInfoModel Inheritance PresentationModel Inheritance EventDispatcher Inheritance Object

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 ProcessInstanceInfoModel class provides support for views that are interested in the data from a ProcessInstance object, which represents a process instance.

Related API Elements

lc.procmgmt.ui.process.ProcessInstanceInfo
lc.procmgmt.domain.ProcessInstance

Public Properties
 PropertyDefined By
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
  errorMessage : Message
[read-only] The error message that is generated when an attempt occurs to access the details of the selected ProcessInstance object.
ProcessInstanceInfoModel
  pendingTasks : ListCollectionView
[read-only] The collection of active tasks, which are represented by Task objects that are associated with the selected ProcessInstance object.
ProcessInstanceInfoModel
  processCompleteTime : Date
[read-only] The time a process instance completed processing.
ProcessInstanceInfoModel
  processDescription : String
[read-only] The description of a process instance.
ProcessInstanceInfoModel
  processInstance : ProcessInstance
The ProcessInstance object to inspect for process instance information.
ProcessInstanceInfoModel
  processInstanceId : Number
[read-only] The unique identifer of a process instance.
ProcessInstanceInfoModel
  processInstanceStatus : String
[read-only] The process instance's status value is a localized string value that is processed by looking up the numeric value in the resource bundle.
ProcessInstanceInfoModel
  processLastUpdatedTime : Date
[read-only] The most recent time a process instance was updated.
ProcessInstanceInfoModel
  processName : String
[read-only] The name of a process instance.
ProcessInstanceInfoModel
  processStartTime : Date
[read-only] The start time of the process instance.
ProcessInstanceInfoModel
  processVariables : ListCollectionView
[read-only] The list of process variables associated with the process instance.
ProcessInstanceInfoModel
 Inheritedsession : SessionMap
A SessionMap object that stores information relating to the server session.
PresentationModel
  showPendingTasks : Boolean
[read-only] A flag that specifies whether pending tasks exist for a process instance.
ProcessInstanceInfoModel
  showProcessVariables : Boolean
[read-only] A flag that specifies whether process variables exist for a process instance.
ProcessInstanceInfoModel
 Inheritedstate : String
[read-only] The name of the state the current view is in.
PresentationModel
Public Methods
 MethodDefined By
  
ProcessInstanceInfoModel()
Constructor.
ProcessInstanceInfoModel
 Inherited
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.
EventDispatcher
 Inherited
bindProperty(destination:Object, destinationProperty:String, source:Object, sourceChain:Object, commitOnly:Boolean = false):ChangeWatcher
Binds a public property on the destination object from a property or property chain on the source object.
PresentationModel
 Inherited
dispatchEvent(event:Event):Boolean
Dispatches an event into the event flow.
EventDispatcher
 Inherited
getCSSStyle(declaration:String, styleProperty:String, defaultValue:Object = null):Object
Returns the corresponding cascading style sheet (CSS) property to use based on the specified parameters.
PresentationModel
 Inherited
hasEventListener(type:String):Boolean
Checks whether the EventDispatcher object has any listeners registered for a specific type of event.
EventDispatcher
 Inherited
hasOwnProperty(name:String):Boolean
Indicates whether an object has a specified property defined.
Object
 Inherited
initialize():void
Initializes the presentation model after the view bindings are processed to prevent view bindings from overriding the initial model state.
PresentationModel
 Inherited
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
 Inherited
propertyIsEnumerable(name:String):Boolean
Indicates whether the specified property exists and is enumerable.
Object
 Inherited
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
Removes a listener from the EventDispatcher object.
EventDispatcher
  
reset():void
Reinitializes the selected ProcessInstance object to null.
ProcessInstanceInfoModel
 Inherited
setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void
Sets the availability of a dynamic property for loop operations.
Object
 Inherited
toLocaleString():String
Returns the string representation of this object, formatted according to locale-specific conventions.
Object
 Inherited
toString():String
Returns the string representation of the specified object.
Object
 Inherited
valueOf():Object
Returns the primitive value of the specified object.
Object
 Inherited
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.
EventDispatcher
Protected Methods
 MethodDefined By
 Inherited
setState(newState:String):void
Sets the state property to a new value and causes a PropertyChangeEvent event.
PresentationModel
Events
Click for more information on events
 Event Summary Defined By
 Inherited
activate
[broadcast event] Dispatched when the Flash Player or AIR application gains operating system focus and becomes active.EventDispatcher
 Inherited
deactivate
[broadcast event] Dispatched when the Flash Player or AIR application operating loses system focus and is becoming inactive.EventDispatcher
Public Constants
 ConstantDefined By
  STATE_COMPLETED : String = "completedState"
[static] A special value that specifies that the process instance data has completed loading.
ProcessInstanceInfoModel
  STATE_ERROR : String = "errorState"
[static] A special value that specifies there is a problem retrieving the process instance data.
ProcessInstanceInfoModel
  STATE_INITIAL : String = "initialState"
[static] A special value that specifies when the object is first created.
ProcessInstanceInfoModel
  STATE_RUNNING : String = "runningState"
[static] A special value that specifies that the process instance data is being loaded.
ProcessInstanceInfoModel
Property Detail

errorMessage

property
errorMessage:Message  [read-only]

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 error message that is generated when an attempt occurs to access the details of the selected ProcessInstance object. An error message populates this property only when an error occurs.

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 errorMessage():Message

pendingTasks

property 
pendingTasks:ListCollectionView  [read-only]

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 collection of active tasks, which are represented by Task objects that are associated with the selected ProcessInstance object.

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

processCompleteTime

property 
processCompleteTime:Date  [read-only]

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 time a process instance completed processing.

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

processDescription

property 
processDescription:String  [read-only]

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 description of a 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 processDescription():String

processInstance

property 
processInstance:ProcessInstance

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 ProcessInstance object to inspect for process instance information. Setting the ProcessInstance object drives the loading of pending tasks and the process variables associated with the process instance.



Implementation
    public function get processInstance():ProcessInstance
    public function set processInstance(value:ProcessInstance):void

processInstanceId

property 
processInstanceId:Number  [read-only]

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 unique identifer of a 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

processInstanceStatus

property 
processInstanceStatus:String  [read-only]

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 process instance's status value is a localized string value that is processed by looking up 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():String

Related API Elements

lc.procmgmt.ProcessConstants

processLastUpdatedTime

property 
processLastUpdatedTime:Date  [read-only]

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 most recent time a process instance was updated. The last time a process was updated is calculated by iterating over the collection of Task objects, which are associated with a ProcessInstance object, and then using the date from the last Task object that was updated.

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 processLastUpdatedTime():Date

processName

property 
processName:String  [read-only]

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 name of a 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 processName():String

processStartTime

property 
processStartTime:Date  [read-only]

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 start time 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 processStartTime():Date

processVariables

property 
processVariables:ListCollectionView  [read-only]

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 list of process variables associated with 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

showPendingTasks

property 
showPendingTasks:Boolean  [read-only]

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

A flag that specifies whether pending tasks exist for a process instance. A value of true specifies that one or more pending tasks exist.

The default value is true.

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 showPendingTasks():Boolean

showProcessVariables

property 
showProcessVariables:Boolean  [read-only]

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

A flag that specifies whether process variables exist for a process instance. A value of true specifies thatone or more process variables exist.

The default value is true.

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 showProcessVariables():Boolean
Constructor Detail

ProcessInstanceInfoModel

()Constructor
public function ProcessInstanceInfoModel()

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

Constructor.

Method Detail

reset

()method
public function reset():void

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

Reinitializes the selected ProcessInstance object to null. The properties of this class are bound directly to the ProcessInstance object, therefore, all of its properties are cleared.

Constant Detail

STATE_COMPLETED

Constant
public static const STATE_COMPLETED:String = "completedState"

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

A special value that specifies that the process instance data has completed loading.

STATE_ERROR

Constant 
public static const STATE_ERROR:String = "errorState"

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

A special value that specifies there is a problem retrieving the process instance data.

STATE_INITIAL

Constant 
public static const STATE_INITIAL:String = "initialState"

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

A special value that specifies when the object is first created.

STATE_RUNNING

Constant 
public static const STATE_RUNNING:String = "runningState"

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

A special value that specifies that the process instance data is being loaded.




© 2014 Adobe Systems Incorporated. All rights reserved.
Thu Dec 4 2014, 05:50 PM -08:00
 

 

Legal Notices | Online Privacy Policy