Class WfVariableInfo

java.lang.Object
wt.workflow.definer.WfVariableInfo
All Implemented Interfaces:
Externalizable, Serializable, wt.fc._NetFactor, NetFactor, Evolvable

public class WfVariableInfo extends Object implements Externalizable, NetFactor, Evolvable
Simple structure containing information pertaining to a execution object variable.

Use the newWfVariableInfo static factory method(s), not the WfVariableInfo constructor, to construct instances of this class. Instances must be constructed using the static factory(s), in order to ensure proper initialization of the instance.



Supported API: true

Extendable: false

See Also:
  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    Label for the attribute; Initial value of the variable.
    static final String
    Label for the attribute; Variable name.
    static final String
    Label for the attribute; Determines whether the variable can be modified by the assignee of a task.
  • Method Summary

    Modifier and Type
    Method
    Description
    Gets the value of the attribute: DEFAULT_VALUE.
    Gets the value of the attribute: NAME.
    boolean
    Gets the value of the attribute: READ_ONLY.
    void
    setDefaultValue(Object a_DefaultValue)
    Sets the value of the attribute: DEFAULT_VALUE.
    void
    setName(String a_Name)
    Sets the value of the attribute: NAME.
    void
    setReadOnly(boolean a_ReadOnly)
    Sets the value of the attribute: READ_ONLY.

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait
  • Field Details

    • NAME

      public static final String NAME
      Label for the attribute; Variable name. Must be non null.

      Supported API: true
      See Also:
    • DEFAULT_VALUE

      public static final String DEFAULT_VALUE
      Label for the attribute; Initial value of the variable. The class of the value must be a subclass of the class of the variable.

      Important Note: all primitive variables must be assigned a default value.

      Supported API: true

      See Also:
    • READ_ONLY

      public static final String READ_ONLY
      Label for the attribute; Determines whether the variable can be modified by the assignee of a task. Not enforced internally, just used by the GUI.

      Supported API: true
      See Also:
  • Method Details

    • getName

      public String getName()
      Gets the value of the attribute: NAME. Variable name. Must be non null.

      Supported API: true
      Returns:
      String
    • setName

      public void setName(String a_Name)
      Sets the value of the attribute: NAME. Variable name. Must be non null.

      Supported API: true
      Parameters:
      a_Name -
    • getDefaultValue

      public Object getDefaultValue()
      Gets the value of the attribute: DEFAULT_VALUE. Initial value of the variable. The class of the value must be a subclass of the class of the variable.

      Important Note: all primitive variables must be assigned a default value.

      Supported API: true

      Returns:
      Object
    • setDefaultValue

      public void setDefaultValue(Object a_DefaultValue)
      Sets the value of the attribute: DEFAULT_VALUE. Initial value of the variable. The class of the value must be a subclass of the class of the variable.

      Important Note: all primitive variables must be assigned a default value.

      Supported API: true

      Parameters:
      a_DefaultValue -
    • isReadOnly

      public boolean isReadOnly()
      Gets the value of the attribute: READ_ONLY. Determines whether the variable can be modified by the assignee of a task. Not enforced internally, just used by the GUI.

      Supported API: true
      Returns:
      boolean
    • setReadOnly

      public void setReadOnly(boolean a_ReadOnly)
      Sets the value of the attribute: READ_ONLY. Determines whether the variable can be modified by the assignee of a task. Not enforced internally, just used by the GUI.

      Supported API: true
      Parameters:
      a_ReadOnly -