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>
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:
-
Field Summary
Fields inherited from interface com.appiancorp.suiteapi.common.XMLable
DEFAULT_BUFFER_SIZE
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionint
Compares this priority with another priorityboolean
Returns whether or not this priority is the default priority in the systemReturns the description of the priorityReturns the effective ID for the priority.Returns the collaboration document ID of the icon associated with this priorityboolean
Deprecated.use getDefaultvoid
setDefault
(boolean default_) Sets whether or not this priority is the default priority in the system.void
setDescription
(String description_) Sets the description of the priorityvoid
setEffectiveId
(Long effectiveId_) Sets the effective ID for this priorityvoid
Sets the collaboration document ID of the icon associated with this priorityvoid
setImageLoc
(String imageLoc_) toXML()
Converts this priority to xml and returns it as a string.void
toXML
(StringBuilder buffer_) Converts the priority to XML and stores it in a StringBufferMethods inherited from class com.appiancorp.suiteapi.common.Identity
equals, getId, getName, getUuid, hashCode, setId, setName, setUuid, toString
-
Constructor Details
-
Priority
public Priority()
-
-
Method Details
-
getDescription
Returns the description of the priority- Returns:
- the description of the priority.
-
setDescription
Sets the description of the priority- Parameters:
description_
- the description of the priority.
-
getIconId
Returns the collaboration document ID of the icon associated with this priority- Returns:
- the iconId for the priority
-
setIconId
Sets the collaboration document ID of the icon associated with this priority- Parameters:
iconId_
- the iconId for the priority
-
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
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.use getDefaultReturns 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 oftrue
- Parameters:
default_
- sets whether or not this priority is default.
-
toXML
Converts this priority to xml and returns it as a string. -
toXML
Converts the priority to XML and stores it in a StringBuffer -
compareTo
Compares this priority with another priority- Specified by:
compareTo
in interfaceComparable<Priority>
- Parameters:
obj_
- thePriority
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
- Returns:
- Returns the imageLoc associated with this priority.
-
setImageLoc
- Parameters:
imageLoc_
- The imageLoc to set.
-