Package com.appiancorp.suiteapi.process

Class Priority

java.lang.Object
com.appiancorp.suiteapi.common.Identity
com.appiancorp.suiteapi.process.Priority
All Implemented Interfaces:
LocalId, XMLable, Serializable, Comparable<Priority>
public class Priority extends Identity implements Comparable<Priority>, XMLable
The precedence of any item in its queue. Used primarily for tasks and processes. Priorities are configured web.war/WEB-INF/conf/process/priority-config-process.xml.
See Also:

  • Constructor Details

    • Priority

      public Priority()

  • Method Details

    • getDescription

      public String getDescription()
      Returns the description of the priority
      Returns:
      the description of the priority.

    • setDescription

      public void setDescription(String description_)
      Sets the description of the priority
      Parameters:
      description_ - the description of the priority.

    • getIconId

      public Long getIconId()
      Returns the collaboration document ID of the icon associated with this priority
      Returns:
      the iconId for the priority

    • setIconId

      public void setIconId(Long iconId_)
      Sets the collaboration document ID of the icon associated with this priority
      Parameters:
      iconId_ - the iconId for the priority

    • getEffectiveId

      public Long getEffectiveId()
      Returns the effective ID for the priority. If the priority has not been deregistered, then the effective ID is the same as the ID. If the priority has been deregistered, then the effective ID is the one that corresponds to the next registered priority in the direction of the default priority.
      Returns:
      the effective ID for the priority

    • setEffectiveId

      public void setEffectiveId(Long effectiveId_)
      Sets the effective ID for this priority
      Parameters:
      effectiveId_ - the effective ID for the priority
      See Also:

    • getDefault

      public boolean getDefault()
      Returns whether or not this priority is the default priority in the system
      Returns:
      returns whether or not this priority is default.

    • isDefault

      @Deprecated public boolean isDefault()
      Deprecated.
      use getDefault
      Returns whether or not this priority is the default priority in the system
      Returns:
      returns whether or not this priority is default.

    • setDefault

      public void setDefault(boolean default_)
      Sets whether or not this priority is the default priority in the system. The system default priority is the last priority registered with a default property of true
      Parameters:
      default_ - sets whether or not this priority is default.

    • toXML

      public String toXML()
      Converts this priority to xml and returns it as a string.
      Specified by:
      toXML in interface XMLable
      Returns:
      a String containing the XML serialization of this priority

    • toXML

      public void toXML(StringBuilder buffer_)
      Converts the priority to XML and stores it in a StringBuffer
      Specified by:
      toXML in interface XMLable
      Parameters:
      buffer_ - the StringBuffer to append the XML to

    • compareTo

      public int compareTo(Priority obj_)
      Compares this priority with another priority
      Specified by:
      compareTo in interface Comparable<Priority>
      Parameters:
      obj_ - the Priority to compare this priority to
      Returns:
      -1 if this priority is higher, 0 if the priorities are equal, or 1 if the other priority is higher

    • getImageLoc

      public String getImageLoc()
      Returns:
      Returns the imageLoc associated with this priority.

    • setImageLoc

      public void setImageLoc(String imageLoc_)
      Parameters:
      imageLoc_ - The imageLoc to set.