com.appiancorp.suiteapi.process

Class ProcessModel.Descriptor

java.lang.Object

com.appiancorp.suiteapi.common.LocalizedIdentity

com.appiancorp.suiteapi.process.ProcessModel.Descriptor

All Implemented Interfaces:

java.io.Serializable

Enclosing class:

ProcessModel

public static class ProcessModel.Descriptor
extends LocalizedIdentity

Inner class that holds the name, id, and description of a process model.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static int	SORT_BY_DESCRIPTION Sort constant indicating that a grid of ProcessModels is sorted based on the description field.
static int	SORT_BY_NAME Sort constant indicating that a grid of ProcessModels is sorted based on the name field.
static java.lang.Integer	SORT_PM_CREATORUSERNAME
static java.lang.Integer	SORT_PM_DESCRIPTION
static java.lang.Integer	SORT_PM_FOLDERID
static java.lang.Integer	SORT_PM_ID
static java.lang.Integer	SORT_PM_LOCKEDBY
static java.lang.Integer	SORT_PM_NAME
static java.lang.Integer	SORT_PM_TIMESTAMPCREATED
static java.lang.Integer	SORT_PM_TIMESTAMPUPDATED
static java.lang.Integer	SORT_PM_UUID
static java.lang.Integer	SORT_PM_VALIDATED
static java.lang.Integer	SORT_PM_VERSION
static java.lang.Integer	SORT_PM_VERSIONSTATUS

Constructor Summary

Constructors

Constructor and Description
Descriptor()

Method Summary

Modifier and Type	Method and Description
java.lang.String	getCreatorUsername() Gets the use that created this model.
java.lang.Long	getDashboardId()
LocaleString	getDescription() Gets the localized description of this model.
boolean	getFavorite()
java.lang.Long	getFolderId() Gets the folder in which this model is saved.
java.lang.String	getLastModifiedUsername()
java.lang.String	getLockedBy() Gets the user by whom this model is currently locked.
boolean	getMutablePriority() Determines whether the priority of this model can be chagned.
java.lang.String	getNameEscapeJavascript() Retrieve the model name, escaped into its Javascript String form (eg a tab becomes the characters '\\' and 't').
int	getObjectType() Gets the object type, for use by UI components.
ProcessModelPermissions	getPermissions() Gets the set of permissions that the logged-in user has on this model.
Priority	getPriority() Gets the priority of this model.
static int	getSortProperty(java.lang.String attribute_) Gets the sort property id that corresponds to the given attribute.
java.sql.Timestamp	getTimeStampCreated() Gets the time at which this model was created.
java.lang.String	getTimeStampCreatedPretty() Gets a pretty version of the time at which this model was created, useful for displaying.
java.sql.Timestamp	getTimeStampUpdated() Gets the time at which this model was last updated.
java.lang.String	getTimeStampUpdatedPretty() Gets a pretty version of the time at which this model was last updated, useful for displaying.
java.lang.String	getUuid() Gets the universally unique identifier (uuid) for this model.
java.lang.String	getVersion() Gets the version of this model.
int	getVersionStatus() Gets the version status of this model.
boolean	isEnabled() Determines whether or not this model is enabled.
boolean	isValidated() Determines whether this model is validated.
void	setCreatorUsername(java.lang.String creatorUsername_) Sets the use that created this model.
void	setDashboardId(java.lang.Long dashboardId_)
void	setDescription(LocaleString description_) Sets the localized description of the process model.
void	setEnabled(boolean enabled_) Sets whether or not this model is enabled.
void	setFavorite(boolean favorite_)
void	setFolderId(java.lang.Long folderId_) Sets the folder in which this model is saved.
void	setLastModifiedUsername(java.lang.String lastModifiedUsername)
void	setLockedBy(java.lang.String lockedBy_) Sets the user by whom this model is currently locked.
void	setMutablePriority(boolean mutablePriority_) Sets whether or not the priority of processes of this process model can be changed
void	setObjectType(int objectType_) Sets the object type for this model, which should always be AppianType.PROCESS_MODEL.
void	setPermissions(ProcessModelPermissions permissions_) Sets the set of permissions that the logged-in user has on this model.
void	setPriority(Priority priority_) Sets the priority of this model.
void	setTimeStampCreated(java.sql.Timestamp timeStampCreated_) Sets the time at which this model was created.
void	setTimeStampUpdated(java.sql.Timestamp timeStampUpdated_) Sets the time at which this model was last updated.
void	setUuid(java.lang.String uuid_) Sets the universally unique identifier (uuid) for this model.
void	setValidated(boolean validated_) Sets whether this model is validated.
void	setVersion(java.lang.String version_) Gets the version of this model.
void	setVersionStatus(int versionStatus_) Sets the version status of this model.
java.lang.String	toString() Returns a string representation of the LocalizedIdentity.

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

equals, getId, getIds, getName, hashCode, setId, setName

Methods inherited from class java.lang.Object

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

Field Detail

SORT_BY_NAME

public static final int SORT_BY_NAME

Sort constant indicating that a grid of ProcessModels is sorted based on the name field.

See Also:

Constant Field Values

SORT_BY_DESCRIPTION

public static final int SORT_BY_DESCRIPTION

Sort constant indicating that a grid of ProcessModels is sorted based on the description field.

See Also:

Constant Field Values

SORT_PM_ID

public static final java.lang.Integer SORT_PM_ID

SORT_PM_NAME

public static final java.lang.Integer SORT_PM_NAME

SORT_PM_DESCRIPTION

public static final java.lang.Integer SORT_PM_DESCRIPTION

SORT_PM_VALIDATED

public static final java.lang.Integer SORT_PM_VALIDATED

SORT_PM_LOCKEDBY

public static final java.lang.Integer SORT_PM_LOCKEDBY

SORT_PM_VERSIONSTATUS

public static final java.lang.Integer SORT_PM_VERSIONSTATUS

SORT_PM_VERSION

public static final java.lang.Integer SORT_PM_VERSION

SORT_PM_CREATORUSERNAME

public static final java.lang.Integer SORT_PM_CREATORUSERNAME

SORT_PM_TIMESTAMPCREATED

public static final java.lang.Integer SORT_PM_TIMESTAMPCREATED

SORT_PM_TIMESTAMPUPDATED

public static final java.lang.Integer SORT_PM_TIMESTAMPUPDATED

SORT_PM_FOLDERID

public static final java.lang.Integer SORT_PM_FOLDERID

SORT_PM_UUID

public static final java.lang.Integer SORT_PM_UUID

Constructor Detail

Descriptor

public Descriptor()

Method Detail

getNameEscapeJavascript

public java.lang.String getNameEscapeJavascript()

Retrieve the model name, escaped into its Javascript String form (eg a tab becomes the characters '\\' and 't').

getUuid

@ConvertWith(value=com.appiancorp.kougar.mapper.parameters.UuidParameterConverter.class)
public java.lang.String getUuid()

Gets the universally unique identifier (uuid) for this model. This identifier is important for comparing versions when importing and exporting models.

Returns:

the uuid for this model.

setUuid

public void setUuid(java.lang.String uuid_)

Sets the universally unique identifier (uuid) for this model. This identifier is important for comparing versions when importing and exporting models.

Parameters:

uuid_ - the uuid for this model, as a String.

getTimeStampCreatedPretty

public java.lang.String getTimeStampCreatedPretty()

Gets a pretty version of the time at which this model was created, useful for displaying.

Returns:

the time at which this model was created, in mm/dd/yyyy hh:mm xM format.

getTimeStampUpdatedPretty

public java.lang.String getTimeStampUpdatedPretty()

Gets a pretty version of the time at which this model was last updated, useful for displaying.

Returns:

the time at which this model was last updated, in mm/dd/yyyy hh:mm xM format.

isEnabled

public boolean isEnabled()

Determines whether or not this model is enabled.

Returns:

true if this model is enabled, false otherwise.

setEnabled

public void setEnabled(boolean enabled_)

Sets whether or not this model is enabled.

Parameters:

enabled_ - true if this model is enabled, false otherwise.

getPermissions

public ProcessModelPermissions getPermissions()

Gets the set of permissions that the logged-in user has on this model.

Returns:

the permissions that the logged-in user has on this model.

setPermissions

public void setPermissions(ProcessModelPermissions permissions_)

Sets the set of permissions that the logged-in user has on this model.

Parameters:

permissions_ - the permissions that the logged-in user has on this model.

getFolderId

public java.lang.Long getFolderId()

Gets the folder in which this model is saved.

Returns:

the id of folder in which this model is saved.

setFolderId

public void setFolderId(java.lang.Long folderId_)

Sets the folder in which this model is saved.

Parameters:

folderId_ - the id of the folder in which this model is saved.

isValidated

public boolean isValidated()

Determines whether this model is validated.

Returns:

true if this model is validated, false otherwise.

setValidated

public void setValidated(boolean validated_)

Sets whether this model is validated.

Parameters:

validated_ - true if this model is validated, false otherwise.

getLockedBy

public java.lang.String getLockedBy()

Gets the user by whom this model is currently locked.

Returns:

the username of the user by whom this model is locked, or null if this model is unlocked.

setLockedBy

public void setLockedBy(java.lang.String lockedBy_)

Sets the user by whom this model is currently locked.

Parameters:

lockedBy_ - the username of the user by whom this model is locked, or null if this model is unlocked.

getVersion

public java.lang.String getVersion()

Gets the version of this model.

Returns:

the version of the process model, as a String holding a dot-separated number (such as 1.3.0).

setVersion

public void setVersion(java.lang.String version_)

Gets the version of this model.

Parameters:

version_ - the version of the process model, as a String holding a dot-separated number (such as 1.3.0).

getTimeStampCreated

public java.sql.Timestamp getTimeStampCreated()

Gets the time at which this model was created.

Returns:

the time the process model was created.

setTimeStampCreated

public void setTimeStampCreated(java.sql.Timestamp timeStampCreated_)

Sets the time at which this model was created.

Parameters:

timeStampCreated_ - the time the process model was created.

getTimeStampUpdated

public java.sql.Timestamp getTimeStampUpdated()

Gets the time at which this model was last updated.

Returns:

the time the process model was last updated.

setTimeStampUpdated

public void setTimeStampUpdated(java.sql.Timestamp timeStampUpdated_)

Sets the time at which this model was last updated.

Parameters:

timeStampUpdated_ - the time the process model was last updated.

getCreatorUsername

public java.lang.String getCreatorUsername()

Gets the use that created this model.

Returns:

the username of the user that created this model.

setCreatorUsername

public void setCreatorUsername(java.lang.String creatorUsername_)

Sets the use that created this model.

Parameters:

creatorUsername_ - the username of the user that created this model.

getVersionStatus

public int getVersionStatus()

Gets the version status of this model.

Returns:

the status of this version, as one of the STATUS_XXX constants.

setVersionStatus

public void setVersionStatus(int versionStatus_)

Sets the version status of this model.

Parameters:

versionStatus_ - the status of this version, as one of the STATUS_XXX constants.

getDescription

public LocaleString getDescription()

Gets the localized description of this model.

Returns:

a description of this model.

setDescription

public void setDescription(LocaleString description_)

Sets the localized description of the process model.

Parameters:

description_ - a description of this model.

getSortProperty

public static int getSortProperty(java.lang.String attribute_)

Gets the sort property id that corresponds to the given attribute.

Parameters:

attribute_ - the name of a property of the model descriptor

Returns:

the id of the sort column for the attribute, as one of the SORT_XXX constants.

getObjectType

public int getObjectType()

Gets the object type, for use by UI components. The object type is always AppianType.PROCESS_MODEL.

Returns:

TypedVariable.PROCESS_MODEL.

setObjectType

public void setObjectType(int objectType_)

Sets the object type for this model, which should always be AppianType.PROCESS_MODEL.

Parameters:

objectType_ - the object type for this model, which should always be TypedVariable.PROCESS_MODEL.

getDashboardId

public java.lang.Long getDashboardId()

setDashboardId

public void setDashboardId(java.lang.Long dashboardId_)

getFavorite

public boolean getFavorite()

setFavorite

public void setFavorite(boolean favorite_)

toString

public java.lang.String toString()

Description copied from class: LocalizedIdentity

Returns a string representation of the LocalizedIdentity. In general, the toString method returns a string that "textually represents" this object. Note that the name value will be the encode representation.

Overrides:

toString in class LocalizedIdentity

Returns:

String representation of the object

getLastModifiedUsername

public java.lang.String getLastModifiedUsername()

setLastModifiedUsername

public void setLastModifiedUsername(java.lang.String lastModifiedUsername)

getPriority

public Priority getPriority()

Gets the priority of this model.

Returns:

the priority of this model.

setPriority

public void setPriority(Priority priority_)

Sets the priority of this model.

Parameters:

priority_ - the priority of this model.

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.