com.appiancorp.suiteapi.process

Class Priority

java.lang.Object

com.appiancorp.suiteapi.common.Identity

com.appiancorp.suiteapi.process.Priority

All Implemented Interfaces:

LocalId, XMLable, java.io.Serializable, java.lang.Comparable<Priority>

public class Priority
extends Identity
implements java.lang.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:

Serialized Form

Field Summary

Fields inherited from interface com.appiancorp.suiteapi.common.XMLable

DEFAULT_BUFFER_SIZE

Constructor Summary

Constructors

Constructor and Description
Priority()

Method Summary

Modifier and Type	Method and Description
int	compareTo(Priority obj_) Compares this priority with another priority
boolean	getDefault() Returns whether or not this priority is the default priority in the system
java.lang.String	getDescription() Returns the description of the priority
java.lang.Long	getEffectiveId() Returns the effective ID for the priority.
java.lang.Long	getIconId() Returns the collaboration document ID of the icon associated with this priority
java.lang.String	getImageLoc()
boolean	isDefault() Deprecated. use getDefault
void	setDefault(boolean default_) Sets whether or not this priority is the default priority in the system.
void	setDescription(java.lang.String description_) Sets the description of the priority
void	setEffectiveId(java.lang.Long effectiveId_) Sets the effective ID for this priority
void	setIconId(java.lang.Long iconId_) Sets the collaboration document ID of the icon associated with this priority
void	setImageLoc(java.lang.String imageLoc_)
java.lang.String	toXML() Converts this priority to xml and returns it as a string.
void	toXML(java.lang.StringBuilder buffer_) Converts the priority to XML and stores it in a StringBuffer

Methods inherited from class com.appiancorp.suiteapi.common.Identity

equals, getId, getName, getUuid, hashCode, setId, setName, setUuid, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.appiancorp.suiteapi.common.XMLable

toXML

Constructor Detail

Priority

public Priority()

Method Detail

getDescription

public java.lang.String getDescription()

Returns the description of the priority

Returns:

the description of the priority.

setDescription

public void setDescription(java.lang.String description_)

Sets the description of the priority

Parameters:

description_ - the description of the priority.

getIconId

public java.lang.Long getIconId()

Returns the collaboration document ID of the icon associated with this priority

Returns:

the iconId for the priority

setIconId

public void setIconId(java.lang.Long iconId_)

Sets the collaboration document ID of the icon associated with this priority

Parameters:

iconId_ - the iconId for the priority

getEffectiveId

public java.lang.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(java.lang.Long effectiveId_)

Sets the effective ID for this priority

Parameters:

effectiveId_ - the effective ID for the priority

See Also:

getEffectiveId()

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 java.lang.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(java.lang.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 java.lang.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 java.lang.String getImageLoc()

Returns:

Returns the imageLoc associated with this priority.

setImageLoc

public void setImageLoc(java.lang.String imageLoc_)

Parameters:

imageLoc_ - The imageLoc to set.