Package com.opentext.livelink.service.workflowservice

Class ProcessDefinition

  • All Implemented Interfaces:
    IServiceDataObject, java.io.Serializable
    public class ProcessDefinition
extends ServiceDataObject
implements java.io.Serializable
    ProcessDefinition is the definition of the Activities and their relationships that form a single Business Process.
    Version:
    2013-08-26
    See Also:
    Serialized Form

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      Activity[] getActivities()
      Gets the list of Activities that make up the ProcessDefinition.
      Activity getActivities​(int index)
      Gets the value at the specified index in the Activities array.
      ApplicationData[] getApplicationData()
      Gets the list of ApplicationData objects associated with the ProcessDefinition.
      ApplicationData getApplicationData​(int index)
      Gets the value at the specified index in the ApplicationData array.
      ActionOnComplete getCompleteAction()
      Gets the ActionOnComplete object for the ProcessDefinition.
      java.lang.Boolean getDeleteMap()
      Gets whether or not to delete the map on completion.
      java.lang.String getDescription()
      Gets the description of the ProcessDefinition.
      EmailAttachmentAction getEmailAction()
      Gets the EmailAttachmentAction object for the ProcessDefinition.
      java.lang.String getMessage()
      Gets the custom message set for the ProcessDefinition.
      long getObjectID()
      Gets the ID of the ProcessDefinition.
      java.lang.Boolean getResumeOnComplete()
      Gets whether or not to resume on completion.
      java.lang.String[] getRoles()
      Gets the list of Roles to be used with the ProcessDefinition.
      java.lang.String getRoles​(int index)
      Gets the value at the specified index in the Roles array.
      java.lang.Boolean getSkipWeekends()
      Gets whether or not to skip weekends in date calculations.
      java.lang.String getTitle()
      Gets the title of the ProcessDefinition.
      TransitionLink[] getTransitionLinks()
      Gets the links between Activities in the ProcessDefinition.
      TransitionLink getTransitionLinks​(int index)
      Gets the value at the specified index in the TransitionLinks array.
      void load​(com.opentext.api.LLValue value)
      Deserialize an ServiceDataObject from an LLValue that is received from Livelink.
      void setActivities​(int index, Activity value)
      Sets the value at the specified index in the fActivities array.
      void setActivities​(Activity[] value)
      Sets the list of Activities that make up the ProcessDefinition.
      void setApplicationData​(int index, ApplicationData value)
      Sets the value at the specified index in the fApplicationData array.
      void setApplicationData​(ApplicationData[] value)
      Sets the list of ApplicationData objects associated with the ProcessDefinition.
      void setCompleteAction​(ActionOnComplete value)
      Sets the ActionOnComplete object for the ProcessDefinition.
      void setDeleteMap​(java.lang.Boolean value)
      Sets whether or not to delete the map on completion.
      void setDescription​(java.lang.String value)
      Sets the description of the ProcessDefinition.
      void setEmailAction​(EmailAttachmentAction value)
      Sets the EmailAttachmentAction object for the ProcessDefinition.
      void setMessage​(java.lang.String value)
      Sets the custom message set for the ProcessDefinition.
      void setObjectID​(long value)
      Sets the ID of the ProcessDefinition.
      void setResumeOnComplete​(java.lang.Boolean value)
      Sets whether or not to resume on completion.
      void setRoles​(int index, java.lang.String value)
      Sets the value at the specified index in the fRoles array.
      void setRoles​(java.lang.String[] value)
      Sets the list of Roles to be used with the ProcessDefinition.
      void setSkipWeekends​(java.lang.Boolean value)
      Sets whether or not to skip weekends in date calculations.
      void setTitle​(java.lang.String value)
      Sets the title of the ProcessDefinition.
      void setTransitionLinks​(int index, TransitionLink value)
      Sets the value at the specified index in the fTransitionLinks array.
      void setTransitionLinks​(TransitionLink[] value)
      Sets the links between Activities in the ProcessDefinition.
      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

      • ProcessDefinition

        public ProcessDefinition()

    • Method Detail

      • setActivities

        public void setActivities​(Activity[] value)
        Sets the list of Activities that make up the ProcessDefinition.

      • getActivities

        public Activity[] getActivities()
        Gets the list of Activities that make up the ProcessDefinition.

      • setActivities

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

      • getActivities

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

      • setApplicationData

        public void setApplicationData​(ApplicationData[] value)
        Sets the list of ApplicationData objects associated with the ProcessDefinition.

      • getApplicationData

        public ApplicationData[] getApplicationData()
        Gets the list of ApplicationData objects associated with the ProcessDefinition.

      • setApplicationData

        public void setApplicationData​(int index,
                               ApplicationData value)
        Sets the value at the specified index in the fApplicationData array.

      • getApplicationData

        public ApplicationData getApplicationData​(int index)
        Gets the value at the specified index in the ApplicationData array.

      • setCompleteAction

        public void setCompleteAction​(ActionOnComplete value)
        Sets the ActionOnComplete object for the ProcessDefinition.

      • getCompleteAction

        public ActionOnComplete getCompleteAction()
        Gets the ActionOnComplete object for the ProcessDefinition.

      • setDeleteMap

        public void setDeleteMap​(java.lang.Boolean value)
        Sets whether or not to delete the map on completion.

      • getDeleteMap

        public java.lang.Boolean getDeleteMap()
        Gets whether or not to delete the map on completion.

      • setDescription

        public void setDescription​(java.lang.String value)
        Sets the description of the ProcessDefinition.

      • getDescription

        public java.lang.String getDescription()
        Gets the description of the ProcessDefinition.

      • setEmailAction

        public void setEmailAction​(EmailAttachmentAction value)
        Sets the EmailAttachmentAction object for the ProcessDefinition.

      • getEmailAction

        public EmailAttachmentAction getEmailAction()
        Gets the EmailAttachmentAction object for the ProcessDefinition.

      • setMessage

        public void setMessage​(java.lang.String value)
        Sets the custom message set for the ProcessDefinition.

      • getMessage

        public java.lang.String getMessage()
        Gets the custom message set for the ProcessDefinition.

      • setObjectID

        public void setObjectID​(long value)
        Sets the ID of the ProcessDefinition.

      • getObjectID

        public long getObjectID()
        Gets the ID of the ProcessDefinition.

      • setResumeOnComplete

        public void setResumeOnComplete​(java.lang.Boolean value)
        Sets whether or not to resume on completion.

      • getResumeOnComplete

        public java.lang.Boolean getResumeOnComplete()
        Gets whether or not to resume on completion.

      • setRoles

        public void setRoles​(java.lang.String[] value)
        Sets the list of Roles to be used with the ProcessDefinition.

      • getRoles

        public java.lang.String[] getRoles()
        Gets the list of Roles to be used with the ProcessDefinition.

      • setRoles

        public void setRoles​(int index,
                     java.lang.String value)
        Sets the value at the specified index in the fRoles array.

      • getRoles

        public java.lang.String getRoles​(int index)
        Gets the value at the specified index in the Roles array.

      • setSkipWeekends

        public void setSkipWeekends​(java.lang.Boolean value)
        Sets whether or not to skip weekends in date calculations.

      • getSkipWeekends

        public java.lang.Boolean getSkipWeekends()
        Gets whether or not to skip weekends in date calculations.

      • setTitle

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

      • getTitle

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

      • setTransitionLinks

        public void setTransitionLinks​(TransitionLink[] value)
        Sets the links between Activities in the ProcessDefinition.

      • getTransitionLinks

        public TransitionLink[] getTransitionLinks()
        Gets the links between Activities in the ProcessDefinition.

      • setTransitionLinks

        public void setTransitionLinks​(int index,
                               TransitionLink value)
        Sets the value at the specified index in the fTransitionLinks array.

      • getTransitionLinks

        public TransitionLink getTransitionLinks​(int index)
        Gets the value at the specified index in the TransitionLinks array.

      • 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