Package com.appiancorp.suiteapi.process

Class Connection

java.lang.Object
com.appiancorp.suiteapi.process.Connection
All Implemented Interfaces:
JSONable, JSONCacheable, XMLable, Serializable
public class Connection extends Object implements JSONCacheable, XMLable, Serializable
Represents a directional link between two process nodes (startNode and endNode). The current thinking is that the only node that is relevant is the end node, and it is referenced by its guiId. Connections are also known as "flows".
See Also:

  • Field Details

  • Constructor Details

    • Connection

      public Connection()
      Creates a new connection.

  • Method Details

    • getHiddenAttributes

      public HashSet getHiddenAttributes()
      Description copied from interface: JSONable
      Returns the set of attributes (properties) that should not be included in the JSON representation of the object.
      Specified by:
      getHiddenAttributes in interface JSONable
      Returns:
      the set of hidden attributes

    • toXML

      public String toXML()
      converts the connection to XML and returns it as a String
      Specified by:
      toXML in interface XMLable
      Returns:
      The XML representation of this object.

    • toXML

      public void toXML(StringBuilder buffer_)
      Appends an XML representation of this object to the given buffer.
      Specified by:
      toXML in interface XMLable
      Parameters:
      buffer_ - The buffer on which to append the XML representation.

    • getGuiId

      public Long getGuiId()
      See setGuiId(Long).

    • setGuiId

      public void setGuiId(Long guiId_)
      Set the guiId of the connection.

    • getEndNodeGuiId

      public Long getEndNodeGuiId()
      The gui id of the node ProcessNode at the end of this connection. A gui id is the identifier within the context of a process model ProcessModel, and is NOT a primary key.
      Returns:
      the end node gui id for this connection

    • setEndNodeGuiId

      public void setEndNodeGuiId(Long endNodeGuiId_)
      Sets the gui id of the node ProcessNode at the end of this connection. A gui id is the identifier within the context of a process model ProcessModel, and is NOT a primary key.
      Parameters:
      endNodeGuiId_ - the end node gui id to set for this connection

    • toString

      public String toString()
      Creates a String representation of this object, which is useful for debugging.
      Overrides:
      toString in class Object

    • getStartNodeGuiId

      public Long getStartNodeGuiId()
      Gets the gui id of the start node ProcessNode of this connection. A gui id is the identifier within the context of a process model ProcessModel, and is NOT a primary key.
      Returns:
      the start node gui id for this connection

    • setStartNodeGuiId

      public void setStartNodeGuiId(Long startNodeGuiId_)
      Sets the gui id of the start node ProcessNode of this connection. A gui id is the identifier within the context of a process model ProcessModel, and is NOT a primary key.
      Parameters:
      startNodeGuiId_ - the start node gui id to set for this connection

    • setStatus

      public void setStatus(Long status_)
      sets the status of the connection
      Parameters:
      status_ - the status of the connection, which can either

    • getStatus

      public Long getStatus()
      Returns:
      the status of the connection, which can either

    • getFromAnchor

      public Long getFromAnchor()
      Get the anchor of the Node from which this Connection begins.
      Returns:
      The anchor from which this Connection starts.

    • setFromAnchor

      public void setFromAnchor(Long fromAnchor_)
      Set the anchor of the Node from which this Connection begins.
      Parameters:
      fromAnchor_ - The anchor from which this Connection will start

    • getToAnchor

      public Long getToAnchor()
      Get the anchor of the Node at which this Connection terminates.
      Returns:
      The anchor at which this Connection terminates.

    • setToAnchor

      public void setToAnchor(Long toAnchor_)
      Set the anchor of the Node at which this Connection terminates.
      Parameters:
      toAnchor_ - The anchor at which this Connection terminates.

    • isShowArrowhead

      public boolean isShowArrowhead()
      See setShowArrowhead(boolean).

    • setShowArrowhead

      public void setShowArrowhead(boolean showArrowhead_)
      Set whether an arrowhead should be displayed at the end of the connection.

    • getLabel

      public String getLabel()
      Gets the label for this Connection.
      Returns:
      The label for this Connection

    • setLabel

      public void setLabel(String label_)
      Sets the label for this Connection.
      Parameters:
      label_ - The label to set for this Connection

    • getLabelStyle

      public Label getLabelStyle()
      Gets the Label bean which stores the styling information for this Connection's label.
      Returns:
      The Label bean for this Connection

    • setLabelStyle

      public void setLabelStyle(Label labelStyle_)
      Sets the Label bean for this Connection.
      Parameters:
      labelStyle_ - The Label bean to set for this Connection
      See Also:

    • getEndObjectType

      public String getEndObjectType()
      See setEndObjectType(String).

    • setEndObjectType

      public void setEndObjectType(String endObjectType_)
      Set the type of the end object of this connection, for example "ap.gui.Node" or "ap.gui.Annotation".

    • getAssociations

      public Connection[] getAssociations()
      See setAssociations(Connection[]).

    • setAssociations

      public void setAssociations(Connection[] associations_)
      Set the associations of this connection; if this connection is an association itself, this field should be null.

    • isChained

      public boolean isChained()
      Determines whether the next attended activity should be shown immediately, as if part of a wizard.
      Returns:
      true if activity chaining is enabled
      See Also:

    • setChained

      public void setChained(boolean chained_)
      Set whether the next attended activity should be shown immediately, as if part of a wizard.
      Parameters:
      chained_ - true to enable activity chaining
      See Also:

    • isOverridesAssignment

      public boolean isOverridesAssignment()
      Returns true if you want to override the assignment for the next attended activity. This is only relevant if this Connection has activity chaining enabled.
      Returns:
      true if the next attended activity assignment is to be overridden
      See Also:

    • setOverridesAssignment

      public void setOverridesAssignment(boolean overridesAssignment_)
      Set whether or not to override the assignment of the next attended activity. This is only relevant if this Connection has activity chaining enabled.
      Parameters:
      overridesAssignment_ - true to override assignment
      See Also:

    • getSynchronizeData

      public boolean getSynchronizeData()
      Returns true if you want to synchronizeData

    • setSynchronizeData

      public void setSynchronizeData(boolean synchronizeData_)
      Set whether or not to synchronizeData