public abstract class AbstractProcessModel extends LocalizedIdentity implements AppianTypeHolder, JSONCacheable
Modifier and Type | Field and Description |
---|---|
static int |
AUTO_ARCHIVE |
static int |
AUTO_DELETE |
static java.lang.Float |
DEFAULT_COMPLETION
Constant indicating the default time instances of each model
are expected to take to complete.
|
static java.lang.String |
LATEST_PUBLISHED_VERSION |
static int |
NO_CLEANUP |
static int |
RESULT_CODE_INVALID
Constant indicating that a model is invalid.
|
static int |
RESULT_CODE_NO_PERM_PUBLISH
Constant indicating that the current user does not have permissions to
publish the current model.
|
static int |
RESULT_CODE_SUCCESS
Constant indicating that an operation on a model was successful.
|
static int |
STATUS_DRAFT
Constant indicating that a model is in draft state.
|
static int |
STATUS_PUBLISHED
Constant indicating that a model is in published state.
|
static int |
STATUS_VERSION
Constant indicating that a model is in versioned state.
|
static java.lang.String |
SYS_AUTOARCHIVE |
static java.lang.String |
SYS_AUTOARCHIVE_DELAY |
static int |
SYSTEM_DEFAULT |
hiddenAttributes$TRANSIENT
Constructor and Description |
---|
AbstractProcessModel() |
Modifier and Type | Method and Description |
---|---|
void |
fillInAppianTypes(AppianTypeCache appianCache_)
Adds the primary keys of the Appian-typed objects maintained by the
elements in the given array to the cache.
|
protected void |
fillInAppianTypes(AppianTypeCache appianCache_,
AppianTypeHolder[] holders_) |
ActivityClassSchema[] |
getAcSchemas()
Deprecated.
This is a legacy field; it will be removed in the next release.
|
AnnotationArtifact[] |
getAnnotations()
Returns the annotations that this model contains.
|
Attachment[] |
getAttachments()
Gets the attachments that have been attached to this model.
|
int |
getAutoArchiveDelay()
The number of days after process completion to archive a process.
|
int |
getAutoDeleteDelay()
The number of days after process completion to delete a process.
|
int |
getCleanupAction()
Returns the cleanup action defined by one of the constants
AUTO_ARCHIVE, AUTO_DELETE, NO_CLEANUP
|
java.lang.String |
getCreatorUsername()
Gets the user who created this model.
|
Deadline |
getDeadline() |
Security |
getDefaultProcessSecurity()
Gets the default security mapping for processes that are
instances of this model.
|
LocaleString |
getDescription()
Gets the localized name mappings of this model.
|
java.lang.Long |
getEmailAttachmentFolderId() |
java.lang.Long |
getFolderId()
Gets the id of the folder in which this model is saved.
|
FormConfig |
getFormConfig(java.util.Locale locale_)
Gets the form config corresponding to the given locale, or null if
no such config exists.
|
FormConfigMap |
getFormConfigMap()
Gets the form config for this model, which is used when instances
of the model are started.
|
java.lang.Long |
getGroupOwnerId()
Deprecated.
groups do not own processModels anymore.
|
java.util.HashSet |
getHiddenAttributes()
Returns the set of attributes (properties) that should not be included in
the JSON representation of the object.
|
boolean |
getIsPublic() |
Lane[] |
getLanes()
Gets the Lanes of the Process Model.
|
java.lang.String |
getLastModifiedUsername()
Gets the user who last modified this model.
|
java.lang.String |
getLatestVersion()
Gets the latest version of this model as a dot-separated
version number (such as 1.3.0).
|
java.lang.String |
getLockedBy()
Gets the user that has this model locked.
|
java.sql.Timestamp |
getLockedByTime()
Gets the time at which this model was most recently locked,
or
null if the model is not currently locked. |
Note[] |
getNotes()
Gets the notes that have been attached to this model.
|
Note[] |
getNotesWithContent(Note[] notes_)
Gets the notes that have been attached to this model, including
the content of the notes.
|
ProcessModelNotificationSettings |
getNtfSettings() |
java.lang.String |
getOwnerUsername()
Gets the user who owns (created) this model.
|
ProcessModelPermissions |
getPermissions()
Gets the permissions that the currently logged-in user has on
this model.
|
Priority |
getPriority()
Gets the priority of this model.
|
LocaleString |
getProcessName()
Gets the localized name mappings of processes that are started
from this model.
|
Schedule[] |
getSchedules()
Retrieves the schedules on which instances of this model are started.
|
Security |
getSecurity()
Gets the security mapping for this model.
|
java.lang.Long |
getState()
Deprecated.
|
java.lang.Float |
getTargetCompletion()
Gets the target duration in which the process should complete
|
java.sql.Timestamp |
getTimeStampCreated()
Gets the time at which this model was created.
|
java.sql.Timestamp |
getTimeStampUpdated()
Gets the time at which this model was last updated.
|
java.lang.String |
getTimeZoneId() |
java.lang.String |
getUuid()
Gets the univerally 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 the process model is enabled.
|
boolean |
isModified()
Determines whether this model has been modified.
|
boolean |
isMutablePriority()
Determines whether the priority of this model can be changed.
|
boolean |
isUseProcessInitiatorTimeZone() |
boolean |
isValidated()
Determines whether or not this model is validated.
|
void |
setAcSchemas(ActivityClassSchema[] acSchemas_)
Deprecated.
This is a legacy field; it will be removed in the next release.
|
void |
setAnnotations(AnnotationArtifact[] annotations_)
See
getAnnotations() . |
void |
setAttachments(Attachment[] attachments_)
Sets the attachments that have been attached to this model.
|
void |
setAutoArchiveDelay(int autoArchiveDelay_)
Sets the number of days after process completion to archive a process.
|
void |
setAutoDeleteDelay(int autoDeleteDelay_)
Sets the number of days after process completion to delete a process.
|
void |
setCleanupAction(int cleanupAction_)
Sets the cleanup action.
|
void |
setCreatorUsername(java.lang.String creatorUsername_)
Sets the user who created this model.
|
void |
setDeadline(Deadline deadline_) |
void |
setDefaultProcessSecurity(Security defaultProcessSecurity_)
Sets the default security mapping for processes that are
instances of this model.
|
void |
setDescription(LocaleString description_)
Sets the localized name mappings of this process model.
|
void |
setEmailAttachmentFolderId(java.lang.Long emailAttachmentFolderId_) |
void |
setEnabled(boolean enabled_)
Sets whether or not the process model is enabled.
|
void |
setFolderId(java.lang.Long folderId_)
Sets the folder in which this model is saved.
|
void |
setFormConfigMap(FormConfigMap formConfigMap_)
Sets the form config for this model, which is used when instances
of the model are started.
|
void |
setGroupOwnerId(java.lang.Long groupOwnerId_)
Deprecated.
groups do not own processModels anymore.
|
void |
setIsPublic(boolean isPublic_) |
void |
setLanes(Lane[] lanes_)
Sets the Lanes of the Process Model
See {@link #getLanes());
|
void |
setLastModifiedUsername(java.lang.String lastModifiedUsername_)
Sets the user who last modified this model.
|
void |
setLatestVersion(java.lang.String latestVersion_)
Set the latest version of the process model
|
void |
setLockedBy(java.lang.String lockedBy_)
Sets the user who has this model locked.
|
void |
setLockedByTime(java.sql.Timestamp lockedByTime_)
Sets the time at which this model was most recently locked.
|
void |
setModified(boolean modified_)
Sets whether or not the process model has been modified.
|
void |
setMutablePriority(boolean mutablePriority_)
Sets whether the priority of this model can be changed.
|
void |
setNotes(Note[] notes_)
Sets the notes that have been attached to this model.
|
void |
setNtfSettings(ProcessModelNotificationSettings ntfSettings_) |
void |
setOwnerUsername(java.lang.String ownerUsername_)
Sets the owner of the process model.
|
void |
setPermissions(ProcessModelPermissions permissions_)
Sets the permissions that the currently logged-in user has on
this model.
|
void |
setPriority(Priority priority_)
Sets the priority for this model
|
void |
setProcessName(LocaleString processName_)
Sets the localized name mappings of processes that are created
from this model.
|
void |
setSchedules(Schedule[] schedules_)
sets the schedules for the process model.
|
void |
setSecurity(Security security_)
Sets the security mapping for this model.
|
void |
setState(java.lang.Long state_)
Deprecated.
|
void |
setTargetCompletion(java.lang.Float targetCompletion_)
Sets the target duration in which the process should complete
|
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 |
setTimeZoneId(java.lang.String timeZoneId) |
void |
setUseProcessInitiatorTimeZone(boolean useProcessInitiatorTimeZone) |
void |
setUuid(java.lang.String uuid_)
Sets the univerally unique identifier (uuid) for this model.
|
void |
setValidated(boolean validated_)
Sets whether or not the process model is validated
|
void |
setVersion(java.lang.String version_)
Sets the version of this model.
|
void |
setVersionStatus(int versionStatus_)
Sets the version status of the process model
|
public static final java.lang.String LATEST_PUBLISHED_VERSION
public static final int STATUS_DRAFT
public static final int STATUS_VERSION
public static final int STATUS_PUBLISHED
public static final int RESULT_CODE_INVALID
public static final int RESULT_CODE_NO_PERM_PUBLISH
public static final int RESULT_CODE_SUCCESS
public static final java.lang.Float DEFAULT_COMPLETION
public static final int NO_CLEANUP
public static final int AUTO_ARCHIVE
public static final int AUTO_DELETE
public static final int SYSTEM_DEFAULT
public static final java.lang.String SYS_AUTOARCHIVE_DELAY
public static final java.lang.String SYS_AUTOARCHIVE
public java.util.HashSet getHiddenAttributes()
JSONable
getHiddenAttributes
in interface JSONable
public java.lang.String getLatestVersion()
public void setLatestVersion(java.lang.String latestVersion_)
latestVersion_
- latest version of the process model,
as a dot-separated version number (such as 1.3.0).public java.lang.Long getFolderId()
public void setFolderId(java.lang.Long folderId_)
folderId_
- the folder in which this model is saved.public boolean isValidated()
true
if this model is validated,
false
otherwise.public void setValidated(boolean validated_)
validated_
- true
if this model is validated,
false
otherwise.public boolean isEnabled()
true
if this model is enabled,
false
otherwise.public void setEnabled(boolean enabled_)
enabled_
- true
if this model is enabled,
false
otherwise.public java.lang.String getLockedBy()
null
if this model is unlocked.public void setLockedBy(java.lang.String lockedBy_)
lockedBy_
- username of the user who has this model
locked, or null
if the model is unlocked.public java.sql.Timestamp getLockedByTime()
null
if the model is not currently locked.public void setLockedByTime(java.sql.Timestamp lockedByTime_)
lockedByTime_
- the time this model was locked, or
null
if the model is not currently locked.public java.lang.String getVersion()
public void setVersion(java.lang.String version_)
version_
- the version of this model, as a string holding a
dot-separated number (such as 1.3.0).public int getVersionStatus()
STATUS_XXX
constants.public void setVersionStatus(int versionStatus_)
versionStatus_
- the version status to set, as one of the
STATUS_XXX
constants.public Priority getPriority()
public void setPriority(Priority priority_)
priority_
- the priority of this model.public LocaleString getDescription()
public void setDescription(LocaleString description_)
description_
- the description of this model.public boolean isModified()
true
if this model has been modified,
false
otherwise.public void setModified(boolean modified_)
modified_
- true
if this model has been modified,
false
otherwise.public java.sql.Timestamp getTimeStampCreated()
public void setTimeStampCreated(java.sql.Timestamp timeStampCreated_)
timeStampCreated_
- the time at which this model was created.public java.sql.Timestamp getTimeStampUpdated()
public void setTimeStampUpdated(java.sql.Timestamp timeStampUpdated_)
timeStampUpdated_
- the time at which this model was last updated.public java.lang.String getCreatorUsername()
public void setCreatorUsername(java.lang.String creatorUsername_)
creatorUsername_
- the username of the user who created this model.@Deprecated public java.lang.Long getGroupOwnerId()
@Deprecated public void setGroupOwnerId(java.lang.Long groupOwnerId_)
groupOwnerId_
- the id of the group that created this model.public java.lang.String getOwnerUsername()
public void setOwnerUsername(java.lang.String ownerUsername_)
ownerUsername_
- the username of the user who created this model.@Deprecated public java.lang.Long getState()
getVersionStatus()
@Deprecated public void setState(java.lang.Long state_)
setVersionStatus(int)
@Deprecated public ActivityClassSchema[] getAcSchemas()
acSchemaId
property, and tools
relate the activities to their schemas by doing a lookup in this array.
This array is not explicitly stored in the database, but is generated
whenever a process model is retrieved from the database.@Deprecated public void setAcSchemas(ActivityClassSchema[] acSchemas_)
acSchemas_
- the schemas used in this model.public LocaleString getProcessName()
public void setProcessName(LocaleString processName_)
processName_
- the localized name mappings of the process, which
may contain an expression.public Schedule[] getSchedules()
public void setSchedules(Schedule[] schedules_)
protected void fillInAppianTypes(AppianTypeCache appianCache_, AppianTypeHolder[] holders_)
public void fillInAppianTypes(AppianTypeCache appianCache_)
fillInAppianTypes
in interface AppianTypeHolder
ath_
- something that has objects that are of Appian types.public Note[] getNotes()
getNotesWithContent
.public void setNotes(Note[] notes_)
notes_
- the notes that have been attached to this model.public Note[] getNotesWithContent(Note[] notes_)
public java.lang.String getLastModifiedUsername()
public void setLastModifiedUsername(java.lang.String lastModifiedUsername_)
lastModifiedUsername_
- the username of the user who last
modified this model.public Security getDefaultProcessSecurity()
public void setDefaultProcessSecurity(Security defaultProcessSecurity_)
defaultProcessSecurity_
- the default process security
mapping for processes that are instances of this model.public Security getSecurity()
public void setSecurity(Security security_)
security_
- the security mapping for this model.public ProcessModelPermissions getPermissions()
public void setPermissions(ProcessModelPermissions permissions_)
permissions_
- the permissions that the current user has on
this model.public boolean isMutablePriority()
true
if the priority of this model can be
changed, false
otherwise.public void setMutablePriority(boolean mutablePriority_)
mutablePriority_
- true
if the priority of this
model can be changed, false
otherwise.public Attachment[] getAttachments()
public void setAttachments(Attachment[] attachments_)
attachments_
- the attachments that have been attached to this model.public java.lang.Float getTargetCompletion()
public void setTargetCompletion(java.lang.Float targetCompletion_)
targetCompletion_
- the target duration in days in which the process
should completepublic FormConfigMap getFormConfigMap()
public FormConfig getFormConfig(java.util.Locale locale_)
locale_
- public void setFormConfigMap(FormConfigMap formConfigMap_)
@ConvertWith(value=com.appiancorp.kougar.mapper.parameters.UuidParameterConverter.class) public java.lang.String getUuid()
public void setUuid(java.lang.String uuid_)
public AnnotationArtifact[] getAnnotations()
public void setAnnotations(AnnotationArtifact[] annotations_)
getAnnotations()
.public java.lang.Long getEmailAttachmentFolderId()
public void setEmailAttachmentFolderId(java.lang.Long emailAttachmentFolderId_)
public boolean getIsPublic()
public void setIsPublic(boolean isPublic_)
public Lane[] getLanes()
public void setLanes(Lane[] lanes_)
lanes_
- The lanes to set.public Deadline getDeadline()
public void setDeadline(Deadline deadline_)
public ProcessModelNotificationSettings getNtfSettings()
public void setNtfSettings(ProcessModelNotificationSettings ntfSettings_)
ntfSettings_
- The notification settings to set.public int getCleanupAction()
public void setCleanupAction(int cleanupAction_)
cleanupAction_
- public int getAutoArchiveDelay()
public void setAutoArchiveDelay(int autoArchiveDelay_)
autoArchiveDelay_
- public int getAutoDeleteDelay()
public void setAutoDeleteDelay(int autoDeleteDelay_)
autoDeleteDelay_
- public java.lang.String getTimeZoneId()
public void setTimeZoneId(java.lang.String timeZoneId)
public boolean isUseProcessInitiatorTimeZone()
public void setUseProcessInitiatorTimeZone(boolean useProcessInitiatorTimeZone)
Copyright © 2003-2024 Appian Corporation. All Rights Reserved.