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
public class ProcessModelFolder extends Identity implements Cloneable
Bean that represents a folder into which ProcessModels can be stored. Folders are organized hierarchically, and can contain either process models or other process model folders.
See Also:

  • Field Details

    • SORT_BY_ID

      public static final Integer SORT_BY_ID
      Sort by the ID field

    • SORT_BY_NAME

      public static final Integer SORT_BY_NAME
      Sort by the Name field

    • SORT_BY_DESCRIPTION

      public static final Integer SORT_BY_DESCRIPTION
      Sort by the Description field

    • SORT_BY_PARENT_FOLDER_ID

      public static final Integer SORT_BY_PARENT_FOLDER_ID
      Sort by the Parent Folder ID field

    • SORT_BY_PARENT_FOLDER_NAME

      public static final Integer SORT_BY_PARENT_FOLDER_NAME
      Sort by the Parent Folder Name field

    • SORT_BY_NUMBER_PROCESS_MODELS

      public static final Integer SORT_BY_NUMBER_PROCESS_MODELS
      Sort by the Number Process Models (number of process models that the folder contains) field

    • SORT_BY_DATE_CREATED

      public static final Integer SORT_BY_DATE_CREATED
      Sort by the Date Created field

    • SORT_BY_CREATOR

      public static final Integer SORT_BY_CREATOR
      Sort by the Creator (username of the creator) field

    • SORT_BY_TYPE

      public static final Integer SORT_BY_TYPE
      Sort by the Type field

    • SORT_BY_DATE_MODIFIED

      public static final Integer SORT_BY_DATE_MODIFIED
      Sort by the Date Modified

    • SORT_BY_NUM_CHILD_FOLDERS

      public static final Integer SORT_BY_NUM_CHILD_FOLDERS
      Sort by number of child folders

    • TYPE_COMMUNITY

      public static final int TYPE_COMMUNITY
      Constant 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_PRIVATE
      Constant 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

      public static final Long 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 API ProcessDesignService.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

      public ProcessModelFolder(String name)

  • Method Details

    • getUuid

      @ConvertWith(com.appiancorp.kougar.mapper.parameters.UuidParameterConverter.class) public String getUuid()
      Get the uuid of this process model folder.
      Overrides:
      getUuid in class Identity
      Returns:
      The uuid.
      See Also:

    • setUuid

      public void setUuid(String uuid)
      Set the uuid of this process model folder.
      Overrides:
      setUuid in class Identity
      Parameters:
      uuid_ - The uuid.
      See Also:

    • getAncestorFolderNames

      public String[] getAncestorFolderNames()
      Gets the folder's ancestor folder names
      Returns:
      the names of the ancestor folders for this folder

    • setAncestorFolderNames

      public void setAncestorFolderNames(String[] ancestorFolderNames_)
      Sets the ancestor folder names for this folder
      Parameters:
      ancestorFolderNames_ - the names to be set
      See Also:

    • getAncestorFolderIds

      public Long[] getAncestorFolderIds()
      Gets the folder's ancestor folder ids
      Returns:
      the ids of the folder's ancestor folders

    • setAncestorFolderIds

      public void setAncestorFolderIds(Long[] ancestorFolderIds_)
      Sets the ancestor folder ids for this folder
      Parameters:
      ancestorFolderIds_ - the ids to set
      See Also:

    • getNumberOfChildFolders

      public Long getNumberOfChildFolders()
      Gets the number of child folders that this folder has.
      Returns:
      the number of child folders that this folder has.

    • setNumberOfChildFolders

      public void setNumberOfChildFolders(Long numberOfChildFolders_)
      Sets the number of child folders that this folder has.
      Parameters:
      numberOfChildFolders_ - the number of child folders that this folder has.

    • getDescription

      public String getDescription()
      Gets a description of this folder.
      Returns:
      a description of this folder.

    • setDescription

      public void setDescription(String description_)
      Sets a description of this folder.
      Parameters:
      description_ - a description of this folder.

    • getParentFolderId

      public Long getParentFolderId()
      Gets the parent of this folder.
      Returns:
      the id of the folder that contains this folder.

    • setParentFolderId

      public void setParentFolderId(Long parentFolderId_)
      Sets the parent of this folder.
      Parameters:
      parentFolderId_ - the id of the folder that contains this folder.

    • getParentFolderName

      public String getParentFolderName()
      Gets the name of the parent of this folder.
      Returns:
      the name of the folder that contains this folder.

    • setParentFolderName

      public void setParentFolderName(String parentFolderName_)
      Sets the name of the parent of this folder.
      Parameters:
      parentFolderName_ - the id of the folder that contains this folder.

    • getNumberOfProcessModels

      public Long getNumberOfProcessModels()
      Gets the number of process models that are in this folder.
      Returns:
      the number of process models that are in this folder.

    • setNumberOfProcessModels

      public void setNumberOfProcessModels(Long numberOfProcessModels_)
      Sets the number of process models that are in this folder.
      Parameters:
      numberOfProcessModels_ - the number of process models that are in this folder.

    • getDateCreated

      public Timestamp getDateCreated()
      Gets the date on which this folder was created.
      Returns:
      the date on which this folder was created.

    • setDateCreated

      public void setDateCreated(Timestamp dateCreated_)
      Sets the date on which this folder was created.
      Parameters:
      dateCreated_ - the date on which this folder was created.

    • getDateModified

      public Timestamp getDateModified()
      Gets the date on which this folder was modified.
      Returns:
      the date on which this folder was modified.

    • setDateModified

      public void setDateModified(Timestamp dateModified_)
      Sets the date on which this folder was modified.
      Parameters:
      dateModified_ - the date on which this folder was modified.

    • getCreator

      public String getCreator()
      Gets the user who created this folder.
      Returns:
      the username of the user who created this folder.

    • setCreator

      public void setCreator(String creator_)
      Sets the user who created this folder.
      Parameters:
      creator_ - the username of the user who created this folder.

    • getPermissions

      public ProcessModelFolderPermissions 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

      public void setPermissions(ProcessModelFolderPermissions permissions_)
      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 the TYPE_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, and false otherwise.

    • getSortProperty

      public static int getSortProperty(String attribute_)
      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 be TypedVariable.PROCESSMODEL_FOLDER.
      Returns:
      the type of this object

    • setObjectType

      public void setObjectType(int objectType_)
      Sets the type of this object, which should always be TypedVariable.PROCESSMODEL_FOLDER.
      Parameters:
      objectType_ - the type of this object

    • getNameEscapeJavascript

      public String getNameEscapeJavascript()
      Retrieve the folder name, escaped into its JavaScript String form (e.g. a tab becomes the characters '\\' and 't')

    • toString

      public String toString()
      Description copied from class: Identity
      Returns a string representation of the Identity. In general, the toString method returns a string that "textually represents" this object.
      Overrides:
      toString in class Identity
      Returns:
      String representation of the object