Package com.appiancorp.suiteapi.process
Class ProcessModelSummary
java.lang.Object
com.appiancorp.suiteapi.common.Identity
com.appiancorp.suiteapi.process.ProcessModelProperties
com.appiancorp.suiteapi.process.ProcessModelSummary
- All Implemented Interfaces:
LocalId
,XMLable
,Serializable
- Direct Known Subclasses:
ProcessModelDetails
Holds summary information about a process model, such as who created it,
when, how many process instances are running, and how many have completed.
- See Also:
-
Field Summary
Fields inherited from interface com.appiancorp.suiteapi.common.XMLable
DEFAULT_BUFFER_SIZE
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionGets the time at which this model was created.Gets the user who created this model.Gets the name of the default process priority for processes of this model.boolean
Returns whether or not the process model is one of the users favorites.Gets the time at whcih this model was last modified.Gets the latest published version of this model.boolean
Determines whether the priority of this model can be chagned.Gets the permissions that the logged-in user has for this model.Gets the priority of this model.static int
getSortProperty
(String attribute_) Gets the zero-based index of the column whose name is the given parameter.Gets the name of the status of this model.Gets the target duration in which the process should completevoid
setCreatedTime
(Timestamp time_) Sets the time at which this model was created.void
setCreator
(String creator_) Sets the user who created this model.void
setDefaultProcessPriorityName
(String processPriorityName_) Sets the name of the default process priority for processes of this model.void
setFavorite
(boolean favorite_) void
setLastModifiedTime
(Timestamp modifiedTime_) Sets the time at whcih this model was last modified.void
setLatestPublishedVersion
(String version_) Sets the latest published version of this model.void
setMutablePriority
(boolean mutablePriority_) Sets whether or not the priority of processes of this process model can be changedvoid
setPermissions
(ProcessModelPermissions permissions_) Sets the permissions that the logged-in user has for this model.void
setPriority
(Priority priority_) Sets the priority of this model.void
setStatusName
(String name_) Sets the name of the status of this model.void
setTargetCompletion
(Float targetCompletion_) Sets the target duration in which the process should completetoXML()
Generates an XML representaion of this summary.void
toXML
(StringBuilder buffer_) Appends an XML representation of this object to the given buffer.Methods inherited from class com.appiancorp.suiteapi.process.ProcessModelProperties
getDescription, getDesigner, getProcessModelVersionId, setDescription, setDesigner, setProcessModelVersionId, toString
Methods inherited from class com.appiancorp.suiteapi.common.Identity
equals, getId, getName, getUuid, hashCode, setId, setName, setUuid
-
Constructor Details
-
ProcessModelSummary
public ProcessModelSummary()
-
-
Method Details
-
getLatestPublishedVersion
Gets the latest published version of this model.- Returns:
- the latest published version of the process model, as
a
String
of dot-separated numbers (such as 1.3.0).
-
setLatestPublishedVersion
Sets the latest published version of this model.- Parameters:
version_
- the latest published version of the process model, as aString
of dot-separated numbers (such as 1.3.0).
-
getMutablePriority
public boolean getMutablePriority()Determines whether the priority of this model can be chagned.- Returns:
true
if the priority can be change,false
if it cannot be changed.
-
setMutablePriority
public void setMutablePriority(boolean mutablePriority_) Sets whether or not the priority of processes of this process model can be changed- Parameters:
mutablePriority_
-true
if the priority of processes of this model can be changed,false
if the priority cannot be changed.
-
getPriority
Gets the priority of this model.- Returns:
- the priority of this model.
-
setPriority
Sets the priority of this model.- Parameters:
priority_
- the priority of this model.
-
getCreatedTime
Gets the time at which this model was created.- Returns:
- the time at which this model was created.
-
setCreatedTime
Sets the time at which this model was created.- Parameters:
time_
- the time at which this model was created.
-
getDefaultProcessPriorityName
Gets the name of the default process priority for processes of this model.- Returns:
- the name of the default priority.
-
setDefaultProcessPriorityName
Sets the name of the default process priority for processes of this model.- Parameters:
processPriorityName_
- the name of the default priority.
-
getLastModifiedTime
Gets the time at whcih this model was last modified.- Returns:
- the time at whcih this model was last modified.
-
setLastModifiedTime
Sets the time at whcih this model was last modified.- Parameters:
modifiedTime_
- the time at whcih this model was last modified.
-
getStatusName
Gets the name of the status of this model.- Returns:
- the name of the status of this model.
-
setStatusName
Sets the name of the status of this model.- Parameters:
name_
- the name of the status of this model.
-
getCreator
Gets the user who created this model.- Returns:
- the username of the user who created this model.
-
setCreator
Sets the user who created this model.- Parameters:
creator_
- the username of the user who created this model.
-
toXML
Generates an XML representaion of this summary. -
toXML
Appends an XML representation of this object to the given buffer. -
getSortProperty
Gets the zero-based index of the column whose name is the given parameter. If no such column exists, returns 0.- Parameters:
attribute_
- the name of an attribute of the summary.- Returns:
- the index of the column that matches the given sort attribute.
-
getPermissions
Gets the permissions that the logged-in user has for this model.- Returns:
- the permissions that the logged-in user has for this model.
-
setPermissions
Sets the permissions that the logged-in user has for this model.- Parameters:
permissions_
- the permissions that the logged-in user has for this model.
-
getTargetCompletion
Gets the target duration in which the process should complete- Returns:
- a value representing the number of days
-
setTargetCompletion
Sets the target duration in which the process should complete- Parameters:
targetCompletion_
- the target duration in days in which the process should complete
-
getFavorite
public boolean getFavorite()Returns whether or not the process model is one of the users favorites.- Returns:
-
setFavorite
public void setFavorite(boolean favorite_)
-