Package com.opentext.livelink.service.workflowservice

Class ProcessInstance

  • All Implemented Interfaces:
    IServiceDataObject, java.io.Serializable
    public class ProcessInstance
extends ServiceDataObject
implements java.io.Serializable
    ProcessInstance is the representation of a single instance of a ProcessDefinition.
    Version:
    2013-08-26
    See Also:
    Serialized Form

    • Constructor Summary

      Constructors 
      Constructor Description
      ProcessInstance()  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      ActivityInstance[] getActivities()
      Gets the list of ActivityInstances contained within this ProcessInstance.
      ActivityInstance getActivities​(int index)
      Gets the value at the specified index in the Activities array.
      java.util.Date getCompletedDate()
      Gets the date the ProcessInstance was completed.
      java.util.Date getDueDate()
      Gets the date the ProcessInstance is due.
      java.util.Date getInitiatedDate()
      Gets the date the ProcessInstance was initiated.
      long getInitiatorID()
      Gets the ID of the user that initiated the ProcessInstance.
      long getManagerID()
      Gets the ID of user that manages the ProcessInstance.
      long getProcessID()
      Gets the ID of the ProcessInstance.
      ProcessStatus getStatus()
      Gets the current status of the ProcessInstance (suspended=1,executing=2,done=-1,stopped=-2,archived=-3).
      long getSubProcessID()
      Gets the ID of the SubProcess of this ProcessInstance.
      java.lang.String getTitle()
      Gets the title of the ProcessInstance.
      void load​(com.opentext.api.LLValue value)
      Deserialize an ServiceDataObject from an LLValue that is received from Livelink.
      void setActivities​(int index, ActivityInstance value)
      Sets the value at the specified index in the fActivities array.
      void setActivities​(ActivityInstance[] value)
      Sets the list of ActivityInstances contained within this ProcessInstance.
      void setCompletedDate​(java.util.Date value)
      Sets the date the ProcessInstance was completed.
      void setDueDate​(java.util.Date value)
      Sets the date the ProcessInstance is due.
      void setInitiatedDate​(java.util.Date value)
      Sets the date the ProcessInstance was initiated.
      void setInitiatorID​(long value)
      Sets the ID of the user that initiated the ProcessInstance.
      void setManagerID​(long value)
      Sets the ID of user that manages the ProcessInstance.
      void setProcessID​(long value)
      Sets the ID of the ProcessInstance.
      void setStatus​(ProcessStatus value)
      Sets the current status of the ProcessInstance (suspended=1,executing=2,done=-1,stopped=-2,archived=-3).
      void setSubProcessID​(long value)
      Sets the ID of the SubProcess of this ProcessInstance.
      void setTitle​(java.lang.String value)
      Sets the title of the ProcessInstance.
      com.opentext.api.LLValue toLLValue()
      Serialize an SDO object to an LLValue that can be sent to Livelink.
      java.lang.String toString()
      Returns a string representation of the object consisting of the object name and any features and their values within square brackets.

      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

    • Constructor Detail

      • ProcessInstance

        public ProcessInstance()

    • Method Detail

      • setActivities

        public void setActivities​(ActivityInstance[] value)
        Sets the list of ActivityInstances contained within this ProcessInstance.

      • getActivities

        public ActivityInstance[] getActivities()
        Gets the list of ActivityInstances contained within this ProcessInstance.

      • setActivities

        public void setActivities​(int index,
                          ActivityInstance value)
        Sets the value at the specified index in the fActivities array.

      • getActivities

        public ActivityInstance getActivities​(int index)
        Gets the value at the specified index in the Activities array.

      • setCompletedDate

        public void setCompletedDate​(java.util.Date value)
        Sets the date the ProcessInstance was completed.

      • getCompletedDate

        public java.util.Date getCompletedDate()
        Gets the date the ProcessInstance was completed.

      • setDueDate

        public void setDueDate​(java.util.Date value)
        Sets the date the ProcessInstance is due.

      • getDueDate

        public java.util.Date getDueDate()
        Gets the date the ProcessInstance is due.

      • setInitiatedDate

        public void setInitiatedDate​(java.util.Date value)
        Sets the date the ProcessInstance was initiated.

      • getInitiatedDate

        public java.util.Date getInitiatedDate()
        Gets the date the ProcessInstance was initiated.

      • setInitiatorID

        public void setInitiatorID​(long value)
        Sets the ID of the user that initiated the ProcessInstance.

      • getInitiatorID

        public long getInitiatorID()
        Gets the ID of the user that initiated the ProcessInstance.

      • setManagerID

        public void setManagerID​(long value)
        Sets the ID of user that manages the ProcessInstance.

      • getManagerID

        public long getManagerID()
        Gets the ID of user that manages the ProcessInstance.

      • setProcessID

        public void setProcessID​(long value)
        Sets the ID of the ProcessInstance.

      • getProcessID

        public long getProcessID()
        Gets the ID of the ProcessInstance.

      • setStatus

        public void setStatus​(ProcessStatus value)
        Sets the current status of the ProcessInstance (suspended=1,executing=2,done=-1,stopped=-2,archived=-3).

      • getStatus

        public ProcessStatus getStatus()
        Gets the current status of the ProcessInstance (suspended=1,executing=2,done=-1,stopped=-2,archived=-3).

      • setSubProcessID

        public void setSubProcessID​(long value)
        Sets the ID of the SubProcess of this ProcessInstance.

      • getSubProcessID

        public long getSubProcessID()
        Gets the ID of the SubProcess of this ProcessInstance.

      • setTitle

        public void setTitle​(java.lang.String value)
        Sets the title of the ProcessInstance.

      • getTitle

        public java.lang.String getTitle()
        Gets the title of the ProcessInstance.

      • load

        public void load​(com.opentext.api.LLValue value)
        Description copied from interface: IServiceDataObject
        Deserialize an ServiceDataObject from an LLValue that is received from Livelink. The LLValue is an Assoc that contains all of the features of this SDO. These features may refer to other SDOs and contain arrays of primitive values or SDOs. Each referenced SDO, will have its load() method called as well. Note: this is an internal method not meant to be called by clients.
        Specified by:
        load in interface IServiceDataObject
        Overrides:
        load in class ServiceDataObject
        Parameters:
        value - the LLValue containing the data to be loaded

      • toLLValue

        public com.opentext.api.LLValue toLLValue()
        Description copied from interface: IServiceDataObject
        Serialize an SDO object to an LLValue that can be sent to Livelink. Each feature of the SDO is stored in a key of the LLValue Assoc. Any references to other SDOs cause their toLLValue() method to be called. Note: this is an internal method not meant to be called by clients.
        Specified by:
        toLLValue in interface IServiceDataObject
        Overrides:
        toLLValue in class ServiceDataObject
        Returns:
        Returns the LLValue object that represents this SDO

      • toString

        public java.lang.String toString()
        Description copied from class: ServiceDataObject
        Returns a string representation of the object consisting of the object name and any features and their values within square brackets. Intended for simple debugging or logging of an SDO.
        Overrides:
        toString in class ServiceDataObject