Package de.elo.ix.client

Class WFDiagram

java.lang.Object
byps.BValueClass
de.elo.ix.client.ValueClass
de.elo.ix.client.WFDiagram
All Implemented Interfaces:
Serializable
public class WFDiagram extends ValueClass implements Serializable
This class represents an active or finished workflow or a workflow template
See Also:

  • Field Details

    • acl

      protected String acl
      Access control list in the internal format. It defines who is able to edit the workflow. This member is only valid for workflow templates.

    • aclItems

      protected AclItem[] aclItems
      Access control list in a more convenient format than member acl. It defines who is able to edit the workflow. This member is only valid for workflow templates.

    • activeAcl

      protected String activeAcl
      Access control list in the internal format. It defines who is able to edit the workflow. This member is only valid for active workflows.
      Since:
      11.00.000.023

    • activeAclItems

      protected AclItem[] activeAclItems
      Access control list in a more convenient format than member acl. It defines who is able to edit the workflow. This member is only valid for active workflows
      Since:
      11.00.000.023

    • completionDateIso

      protected String completionDateIso
      Date of completion in ISO format.

    • deleted

      protected boolean deleted
      Flag that indicates whether the workflow template is deleted. Only valid for template workflows.

    • id

      protected int id
      Workflow ID.

    • lockId

      protected int lockId
      The ID of the user who has currently locked the workflow.

    • lockName

      protected String lockName
      The name of the user who has currently locked the workflow.

    • matrix

      protected WFNodeMatrix matrix
      Node matrix.

    • name

      protected String name
      Workflow name.

    • nodes

      protected WFNode[] nodes
      Array of nodes.

    • objId

      protected String objId
      ID or GUID of the associated folder or document object. checkoutWorkFlow will always return the numeric object ID in this field. checkinWorkFlow is able to receive a GUID too.

    • objType

      protected int objType
      Sord type of the associated folder or document.

    • ownerId

      protected int ownerId
      ID of the user who has started the workflow.

    • ownerName

      protected String ownerName
      Name of the user who has started the workflow.

    • prio

      protected int prio
      Workflow priortiy: 0...high, 1...medium, 2...low.

    • startDateIso

      protected String startDateIso
      Date of start in ISO format.

    • templateId

      protected int templateId
      The workflow was started based on this workflow template. This member is only valid for active and finished workflows.
      See Also:

    • templateName

      protected String templateName
      The workflow was started based on the workflow template with this name. This member is only valid for active and finished workflows.
      See Also:

    • timeLimit

      protected int timeLimit
      Time-limit for the entire workflow in minutes.
      See Also:

    • timeLimitIso

      protected String timeLimitIso
      The entire workflow should be finished by this date. Otherwise the time-limit is exceeded. This member is only valid for active and finished workflows. Read-only.
      See Also:

    • timeLimitUserId

      protected int timeLimitUserId
      The ID of the user that should be informed,if the time-limit for the workflow is exceeded. The Indexserver does not send any notification to the user. The client application is responsible for doing this.
      See Also:

    • timeLimitUserName

      protected String timeLimitUserName
      The name of the user that should be informed, if the time-limit is exceeded. When writing a workflow with checkinWorkFlow, this value has preceedence before timeLimitUserId. Set timeLimitUserName to an empty string, if timeLimitUserId should be used.

    • type

      protected WFTypeZ type
      Typeof template: template, active or finished.

    • overTimeLimit

      protected boolean overTimeLimit
      True, if the workflow exceeds the time limit. Read-only.
      Since:
      6.00.096

    • flags

      protected int flags
      Flags of the begin node. This value is a combination of the node flags suitable to begin nodes, e. g. WFNodeC.FLAG_WORKINGDAYS. To ensure compatibility with older client programs, the WFNode.flags of the start node are or-ed with the WFDiagram.flags.
      Since:
      6.00.098
      See Also:

    • access

      protected int access
      Access rights to the workflow template for the current user. A combination of LUR_* constants. Read-only.
      Since:
      7.00.000.007
      See Also:

    • version

      protected WFVersion version
      Only templates: version information.
      Since:
      7.00.000.008
      See Also:

    • guid

      protected String guid
      GUID
      Since:
      7.00.000.010

    • tStamp

      protected String tStamp
      TStamp
      Since:
      7.00.000.010

    • processOnServerId

      protected String processOnServerId
      This value determines on which replication server a workflow is allowed to be continued. If not empty, the workflow can only be modified and continued on this server (resp. replication branch). Value must match to an existing ReplSetName.name in the replication configuration. The current local replication server id is specified in ServerInfo.replProcessOnServerId. This member is only valid for ACTIVE or FINISHED workflows and is set automatically by the Indexserver. It can be changed within workflows with WFNodeC.TYPE_SET_SERVER_ID nodes.
      Since:
      7.00.000.015
      See Also:

    • timeLimitEscalations

      protected WFTimeLimit[] timeLimitEscalations
      Additional definitions for time limits.
      Since:
      7.00.000.016
      See Also:

    • objName

      protected String objName
      Sord name. Readonly.
      Since:
      7.00.026.003

    • TStampSync

      protected String TStampSync
      Timestamp of this object's last export by the replication.
      Since:
      9.99.009.001

    • nameTranslationKey

      protected String nameTranslationKey
      Translation-keyword for name.
      Since:
      9.00.018.005

    • hidden

      protected boolean hidden
      Indicates whether this workflow is hidden.
      Since:
      9.00.018.006

    • parentFlowId

      protected int parentFlowId
      ID of the parent workflow.
      Since:
      9.00.030.022

    • callNodeId

      protected int callNodeId
      The call node id of the main workflow, which call this sub workflow.
      Since:
      10.00.000.004

    • subWorkflows

      protected Map<Integer,WFDiagram> subWorkflows
      Sub workflows.
      Since:
      9.00.030.022

    • packageName

      protected String packageName
      Package name of WFDiagram
      Since:
      20.00.000.009

  • Constructor Details

    • WFDiagram

      public WFDiagram()

    • WFDiagram

      public WFDiagram(WFDiagram rhs)

  • Method Details

    • getActiveAcl

      public String getActiveAcl()

    • setActiveAcl

      public void setActiveAcl(String activeAcl)

    • getActiveAclItems

      public AclItem[] getActiveAclItems()

    • setActiveAclItems

      public void setActiveAclItems(AclItem[] activeAclItems)

    • getAcl

      public String getAcl()

    • setAcl

      public void setAcl(String acl)

    • getAclItems

      public AclItem[] getAclItems()

    • setAclItems

      public void setAclItems(AclItem[] aclItems)

    • getCompletionDateIso

      public String getCompletionDateIso()

    • setCompletionDateIso

      public void setCompletionDateIso(String completionDateIso)

    • isDeleted

      public boolean isDeleted()

    • isOverTimeLimit

      public boolean isOverTimeLimit()

    • setOverTimeLimit

      public void setOverTimeLimit(boolean overTimeLimit)

    • setDeleted

      public void setDeleted(boolean deleted)

    • getId

      public int getId()

    • setId

      public void setId(int id)

    • getLockId

      public int getLockId()

    • setLockId

      public void setLockId(int lockId)

    • getLockName

      public String getLockName()

    • setLockName

      public void setLockName(String lockName)

    • getMatrix

      public WFNodeMatrix getMatrix()

    • setMatrix

      public void setMatrix(WFNodeMatrix matrix)

    • getName

      public String getName()

    • setName

      public void setName(String name)

    • getNodes

      public WFNode[] getNodes()

    • setNodes

      public void setNodes(WFNode[] nodes)

    • getObjId

      public String getObjId()

    • setObjId

      public void setObjId(String objId)

    • getObjType

      public int getObjType()

    • setObjType

      public void setObjType(int objType)

    • getOwnerId

      public int getOwnerId()

    • setOwnerId

      public void setOwnerId(int ownerId)

    • getOwnerName

      public String getOwnerName()

    • setOwnerName

      public void setOwnerName(String ownerName)

    • getPrio

      public int getPrio()

    • setPrio

      public void setPrio(int prio)

    • getStartDateIso

      public String getStartDateIso()

    • setStartDateIso

      public void setStartDateIso(String startDateIso)

    • getTemplateId

      public int getTemplateId()

    • setTemplateId

      public void setTemplateId(int templateId)

    • getTemplateName

      public String getTemplateName()

    • setTemplateName

      public void setTemplateName(String templateName)

    • getTimeLimit

      public int getTimeLimit()

    • setTimeLimit

      public void setTimeLimit(int timeLimit)

    • getTimeLimitIso

      public String getTimeLimitIso()

    • setTimeLimitIso

      public void setTimeLimitIso(String timeLimitIso)

    • getTimeLimitUserId

      public int getTimeLimitUserId()

    • setTimeLimitUserId

      public void setTimeLimitUserId(int timeLimitUserId)

    • getTimeLimitUserName

      public String getTimeLimitUserName()

    • setTimeLimitUserName

      public void setTimeLimitUserName(String timeLimitUserName)

    • getType

      public WFTypeZ getType()

    • setType

      public void setType(WFTypeZ type)

    • getFlags

      public int getFlags()

    • setFlags

      public void setFlags(int flags)

    • getAccess

      public int getAccess()

    • setAccess

      public void setAccess(int access)

    • getVersion

      public WFVersion getVersion()

    • setVersion

      public void setVersion(WFVersion v)

    • getGuid

      public String getGuid()

    • setGuid

      public void setGuid(String guid)

    • getTStamp

      public String getTStamp()

    • setTStamp

      public void setTStamp(String stamp)

    • getProcessOnServerId

      public String getProcessOnServerId()

    • setProcessOnServerId

      public void setProcessOnServerId(String processOnServerId)

    • getTimeLimitEscalations

      public WFTimeLimit[] getTimeLimitEscalations()

    • setTimeLimitEscalations

      public void setTimeLimitEscalations(WFTimeLimit[] timeLimitEscalation)

    • getObjName

      public String getObjName()

    • setObjName

      public void setObjName(String objName)

    • getTStampSync

      public String getTStampSync()

    • setTStampSync

      public void setTStampSync(String TStampSync)

    • getNameTranslationKey

      public String getNameTranslationKey()

    • setNameTranslationKey

      public void setNameTranslationKey(String nameTranslationKey)

    • isHidden

      public boolean isHidden()

    • setHidden

      public void setHidden(boolean hidden)

    • getParentFlowId

      public int getParentFlowId()

    • setParentFlowId

      public void setParentFlowId(int parentFlowId)

    • getSubWorkflows

      public Map<Integer,WFDiagram> getSubWorkflows()

    • setSubWorkflows

      public void setSubWorkflows(Map<Integer,WFDiagram> subWorkflows)

    • getCallNodeId

      public int getCallNodeId()
      Returns:
      the callNodeId

    • setCallNodeId

      public void setCallNodeId(int callNodeId)
      Parameters:
      callNodeId - the callNodeId to set

    • getPackageName

      public String getPackageName()

    • setPackageName

      public void setPackageName(String packageName)

    • toString

      public String toString()
      Overrides:
      toString in class Object