Package com.appiancorp.suiteapi.process
Class ProcessModelFolder
java.lang.Object
com.appiancorp.suiteapi.common.Identity
com.appiancorp.suiteapi.process.ProcessModelFolder
- All Implemented Interfaces:
LocalId
,Serializable
,Cloneable
Bean that represents a folder into which
ProcessModel
s
can be stored. Folders are organized hierarchically, and can
contain either process models or other process model folders.- See Also:
-
Field Summary
Modifier and TypeFieldDescriptionstatic final Long
The id of the My Models folder.static final Integer
Sort by the Creator (username of the creator) fieldstatic final Integer
Sort by the Date Created fieldstatic final Integer
Sort by the Date Modifiedstatic final Integer
Sort by the Description fieldstatic final Integer
Sort by the ID fieldstatic final Integer
Sort by the Name fieldstatic final Integer
Sort by number of child foldersstatic final Integer
Sort by the Number Process Models (number of process models that the folder contains) fieldstatic final Integer
Sort by the Parent Folder ID fieldstatic final Integer
Sort by the Parent Folder Name fieldstatic final Integer
Sort by the Type fieldstatic final int
Constant indicating that a folder is of type community.static final int
Constant indicating that a folder is of type private. -
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionLong[]
Gets the folder's ancestor folder idsString[]
Gets the folder's ancestor folder namesGets the user who created this folder.Gets the date on which this folder was created.Gets the date on which this folder was modified.Gets a description of this folder.Retrieve the folder name, escaped into its JavaScript String form (e.g.Gets the number of child folders that this folder has.Gets the number of process models that are in this folder.int
Gets the type of this object, which should always beTypedVariable.PROCESSMODEL_FOLDER
.Gets the parent of this folder.Gets the name of the parent of this folder.Gets the permissions that the currently logged-in user has on this folder.static int
getSortProperty
(String attribute_) Gets the (zero-based) index of the sort property referred to by the given attribute.int
getType()
Gets the type of this foldergetUuid()
Get the uuid of this process model folder.boolean
Returns whether this is the special "My Models" folder.void
setAncestorFolderIds
(Long[] ancestorFolderIds_) Sets the ancestor folder ids for this foldervoid
setAncestorFolderNames
(String[] ancestorFolderNames_) Sets the ancestor folder names for this foldervoid
setCreator
(String creator_) Sets the user who created this folder.void
setDateCreated
(Timestamp dateCreated_) Sets the date on which this folder was created.void
setDateModified
(Timestamp dateModified_) Sets the date on which this folder was modified.void
setDescription
(String description_) Sets a description of this folder.void
setNumberOfChildFolders
(Long numberOfChildFolders_) Sets the number of child folders that this folder has.void
setNumberOfProcessModels
(Long numberOfProcessModels_) Sets the number of process models that are in this folder.void
setObjectType
(int objectType_) Sets the type of this object, which should always beTypedVariable.PROCESSMODEL_FOLDER
.void
setParentFolderId
(Long parentFolderId_) Sets the parent of this folder.void
setParentFolderName
(String parentFolderName_) Sets the name of the parent of this folder.void
setPermissions
(ProcessModelFolderPermissions permissions_) Sets the permissions that the currently logged-in user has on this folder.void
setSpecial
(boolean special_) Sets whether this is the special "My Models" folder or not.void
setType
(int type_) Sets the type of this foldervoid
Set the uuid of this process model folder.toString()
Returns a string representation of theIdentity
.
-
Field Details
-
SORT_BY_ID
Sort by the ID field -
SORT_BY_NAME
Sort by the Name field -
SORT_BY_DESCRIPTION
Sort by the Description field -
SORT_BY_PARENT_FOLDER_ID
Sort by the Parent Folder ID field -
SORT_BY_PARENT_FOLDER_NAME
Sort by the Parent Folder Name field -
SORT_BY_NUMBER_PROCESS_MODELS
Sort by the Number Process Models (number of process models that the folder contains) field -
SORT_BY_DATE_CREATED
Sort by the Date Created field -
SORT_BY_CREATOR
Sort by the Creator (username of the creator) field -
SORT_BY_TYPE
Sort by the Type field -
SORT_BY_DATE_MODIFIED
Sort by the Date Modified -
SORT_BY_NUM_CHILD_FOLDERS
Sort by number of child folders -
TYPE_COMMUNITY
public static final int TYPE_COMMUNITYConstant indicating that a folder is of type community. This includes all folders other than the "My Models" folder and sub-folders of "My Models".- See Also:
-
TYPE_PRIVATE
public static final int TYPE_PRIVATEConstant indicating that a folder is of type private. The "My Models" folder and sub-folders of "My Models" are of type private.- See Also:
-
MY_MODELS_FOLDER_ID
The id of the My Models folder. This id can be used to retrieve the My Models folder for any user using the APIProcessDesignService.getFolder(Long)
. The id is the same for all users, because the service context used when invoking the API determines the actual folder that is returned.
-
-
Constructor Details
-
ProcessModelFolder
public ProcessModelFolder() -
ProcessModelFolder
-
-
Method Details
-
getUuid
@ConvertWith(com.appiancorp.kougar.mapper.parameters.UuidParameterConverter.class) public String getUuid()Get the uuid of this process model folder. -
setUuid
Set the uuid of this process model folder. -
getAncestorFolderNames
Gets the folder's ancestor folder names- Returns:
- the names of the ancestor folders for this folder
-
setAncestorFolderNames
Sets the ancestor folder names for this folder- Parameters:
ancestorFolderNames_
- the names to be set- See Also:
-
getAncestorFolderIds
Gets the folder's ancestor folder ids- Returns:
- the ids of the folder's ancestor folders
-
setAncestorFolderIds
Sets the ancestor folder ids for this folder- Parameters:
ancestorFolderIds_
- the ids to set- See Also:
-
getNumberOfChildFolders
Gets the number of child folders that this folder has.- Returns:
- the number of child folders that this folder has.
-
setNumberOfChildFolders
Sets the number of child folders that this folder has.- Parameters:
numberOfChildFolders_
- the number of child folders that this folder has.
-
getDescription
Gets a description of this folder.- Returns:
- a description of this folder.
-
setDescription
Sets a description of this folder.- Parameters:
description_
- a description of this folder.
-
getParentFolderId
Gets the parent of this folder.- Returns:
- the id of the folder that contains this folder.
-
setParentFolderId
Sets the parent of this folder.- Parameters:
parentFolderId_
- the id of the folder that contains this folder.
-
getParentFolderName
Gets the name of the parent of this folder.- Returns:
- the name of the folder that contains this folder.
-
setParentFolderName
Sets the name of the parent of this folder.- Parameters:
parentFolderName_
- the id of the folder that contains this folder.
-
getNumberOfProcessModels
Gets the number of process models that are in this folder.- Returns:
- the number of process models that are in this folder.
-
setNumberOfProcessModels
Sets the number of process models that are in this folder.- Parameters:
numberOfProcessModels_
- the number of process models that are in this folder.
-
getDateCreated
Gets the date on which this folder was created.- Returns:
- the date on which this folder was created.
-
setDateCreated
Sets the date on which this folder was created.- Parameters:
dateCreated_
- the date on which this folder was created.
-
getDateModified
Gets the date on which this folder was modified.- Returns:
- the date on which this folder was modified.
-
setDateModified
Sets the date on which this folder was modified.- Parameters:
dateModified_
- the date on which this folder was modified.
-
getCreator
Gets the user who created this folder.- Returns:
- the username of the user who created this folder.
-
setCreator
Sets the user who created this folder.- Parameters:
creator_
- the username of the user who created this folder.
-
getPermissions
Gets the permissions that the currently logged-in user has on this folder.- Returns:
- the permissions that the currently logged-in user has on this folder.
-
setPermissions
Sets the permissions that the currently logged-in user has on this folder.- Parameters:
permissions_
- the permissions that the currently logged-in user has on this folder.
-
getType
public int getType()Gets the type of this folder- Returns:
- the type of this folder, as one of the
TYPE_XXX
constants.
-
setType
public void setType(int type_) Sets the type of this folder- Parameters:
type_
- the type of this folder, which should be one of theTYPE_XXX
constants.
-
isSpecial
public boolean isSpecial()Returns whether this is the special "My Models" folder. -
setSpecial
public void setSpecial(boolean special_) Sets whether this is the special "My Models" folder or not.- Parameters:
special_
-true
, if this is the special "My Models" folder, andfalse
otherwise.
-
getSortProperty
Gets the (zero-based) index of the sort property referred to by the given attribute.- Parameters:
attribute_
- the name of a property of this bean- Returns:
- the index on which to sort, or 1 if the attribute is not recognized.
-
getObjectType
public int getObjectType()Gets the type of this object, which should always beTypedVariable.PROCESSMODEL_FOLDER
.- Returns:
- the type of this object
-
setObjectType
public void setObjectType(int objectType_) Sets the type of this object, which should always beTypedVariable.PROCESSMODEL_FOLDER
.- Parameters:
objectType_
- the type of this object
-
getNameEscapeJavascript
Retrieve the folder name, escaped into its JavaScript String form (e.g. a tab becomes the characters '\\' and 't') -
toString
Description copied from class:Identity
Returns a string representation of theIdentity
. In general, the toString method returns a string that "textually represents" this object.
-