Packagelc.domain
Classpublic class ProcessInstance
InheritanceProcessInstance Inheritance Object
Implements IWorkspaceManaged

The ProcessInstance class represents a process instance in LiveCycle ES. 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
     PropertyDefined By
     Inheritedconstructor : 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 image location (as a URL) of 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
     Inheritedprototype : Object
    [static] A reference to the prototype object of a class or function object.
    		Object
      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
     MethodDefined By
     Inherited
    hasOwnProperty(name:String):Boolean
    Indicates whether an object has a specified property defined.
    		Object
     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
      
    loadPendingTasks(forceLoad:Boolean = false):Token
    Loads the pending tasks for the process instances.
    		ProcessInstance
      
    loadProcessVariables(forceLoad:Boolean = false):Token
    Loads the process variables for the process instance.
    		ProcessInstance
      
    loadTasks(forceLoad:Boolean = false):Token
    Loads the tasks for the process instances.
    		ProcessInstance
     Inherited
    propertyIsEnumerable(name:String):Boolean
    Indicates whether the specified property exists and is enumerable.
    		Object
     Inherited
    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
     Inherited
    toString():String
    Returns the string representation of the specified object.
    		Object
     Inherited
    valueOf():Object
    Returns the primitive value of the specified object.
    		Object
    Property Detail
    descriptionproperty
    description:String  [read-write]

    The description of the process instance.


    Implementation
        public function get description():String
        public function set description(value:String):void
    imageUrlproperty 
    imageUrl:String  [read-write]

    The image location (as a URL) of the process instance.


    Implementation
        public function get imageUrl():String
        public function set imageUrl(value:String):void
    initiatorproperty 
    initiator:String  [read-write]

    The initiator of the process instance.


    Implementation
        public function get initiator():String
        public function set initiator(value:String):void
    initiatorIdproperty 
    initiatorId:String  [read-write]

    The identifier of the initiator who started the process instance.


    Implementation
        public function get initiatorId():String
        public function set initiatorId(value:String):void
    pendingTasksproperty 
    pendingTasks:ListCollectionView  [read-write]

    The collection of pending tasks for the process instance.


    Implementation
        public function get pendingTasks():ListCollectionView
        public function set pendingTasks(value:ListCollectionView):void
    processCompleteTimeproperty 
    processCompleteTime:Date  [read-write]

    The date and time that the process instance completed.


    Implementation
        public function get processCompleteTime():Date
        public function set processCompleteTime(value:Date):void
    processInstanceIdproperty 
    processInstanceId:Number  [read-write]

    The unique identifier of the process instance.


    Implementation
        public function get processInstanceId():Number
        public function set processInstanceId(value:Number):void
    processInstanceStatusproperty 
    processInstanceStatus:Number  [read-write]

    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.


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

    See also

    lc.ProcessConstants
    processNameproperty 
    processName:String  [read-write]

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


    Implementation
        public function get processName():String
        public function set processName(value:String):void
    processStartTimeproperty 
    processStartTime:Date  [read-write]

    The date and time of the process instance started.


    Implementation
        public function get processStartTime():Date
        public function set processStartTime(value:Date):void
    processVariablesproperty 
    processVariables:ListCollectionView  [read-write]

    The collection of process variables for the process instance.


    Implementation
        public function get processVariables():ListCollectionView
        public function set processVariables(value:ListCollectionView):void
    sessionproperty 
    session:SessionMap  [read-only]

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


    Implementation
        public function get session():SessionMap
    tasksproperty 
    tasks:ListCollectionView  [read-write]

    The collection of tasks for the process instance.


    Implementation
        public function get tasks():ListCollectionView
        public function set tasks(value:ListCollectionView):void
    Method Detail
    loadPendingTasks()method
    public function loadPendingTasks(forceLoad:Boolean = false):Token

    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
    Token — A token that can be used by the caller to specify handlers for this asynchronous call.
    loadProcessVariables()method 
    public function loadProcessVariables(forceLoad:Boolean = false):Token

    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
    Token — A token that can be used by the caller to specify handlers for this asynchronous call.
    loadTasks()method 
    public function loadTasks(forceLoad:Boolean = false):Token

    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
    Token — A token that can be used by the caller to specify handlers for this asynchronous call.
    setSession()method 
    public function setSession(session:SessionMap):void

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

    Parameters

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




    © 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/domain/ProcessInstance.html