com.appiancorp.suiteapi.process

Class ProcessModelFolder

java.lang.Object

com.appiancorp.suiteapi.common.Identity

com.appiancorp.suiteapi.process.ProcessModelFolder

All Implemented Interfaces:

LocalId, java.io.Serializable, java.lang.Cloneable

public class ProcessModelFolder
extends Identity
implements java.lang.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:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.Long	MY_MODELS_FOLDER_ID The id of the My Models folder.
static java.lang.Integer	SORT_BY_CREATOR Sort by the Creator (username of the creator) field
static java.lang.Integer	SORT_BY_DATE_CREATED Sort by the Date Created field
static java.lang.Integer	SORT_BY_DATE_MODIFIED Sort by the Date Modified
static java.lang.Integer	SORT_BY_DESCRIPTION Sort by the Description field
static java.lang.Integer	SORT_BY_ID Sort by the ID field
static java.lang.Integer	SORT_BY_NAME Sort by the Name field
static java.lang.Integer	SORT_BY_NUM_CHILD_FOLDERS Sort by number of child folders
static java.lang.Integer	SORT_BY_NUMBER_PROCESS_MODELS Sort by the Number Process Models (number of process models that the folder contains) field
static java.lang.Integer	SORT_BY_PARENT_FOLDER_ID Sort by the Parent Folder ID field
static java.lang.Integer	SORT_BY_PARENT_FOLDER_NAME Sort by the Parent Folder Name field
static java.lang.Integer	SORT_BY_TYPE Sort by the Type field
static int	TYPE_COMMUNITY Constant indicating that a folder is of type community.
static int	TYPE_PRIVATE Constant indicating that a folder is of type private.

Constructor Summary

Constructors

Constructor and Description
ProcessModelFolder()
ProcessModelFolder(java.lang.String name)

Method Summary

Modifier and Type	Method and Description
java.lang.Long[]	getAncestorFolderIds() Gets the folder's ancestor folder ids
java.lang.String[]	getAncestorFolderNames() Gets the folder's ancestor folder names
java.lang.String	getCreator() Gets the user who created this folder.
java.sql.Timestamp	getDateCreated() Gets the date on which this folder was created.
java.sql.Timestamp	getDateModified() Gets the date on which this folder was modified.
java.lang.String	getDescription() Gets a description of this folder.
java.lang.String	getNameEscapeJavascript() Retrieve the folder name, escaped into its JavaScript String form (e.g.
java.lang.Long	getNumberOfChildFolders() Gets the number of child folders that this folder has.
java.lang.Long	getNumberOfProcessModels() Gets the number of process models that are in this folder.
int	getObjectType() Gets the type of this object, which should always be TypedVariable.PROCESSMODEL_FOLDER.
java.lang.Long	getParentFolderId() Gets the parent of this folder.
java.lang.String	getParentFolderName() Gets the name of the parent of this folder.
ProcessModelFolderPermissions	getPermissions() Gets the permissions that the currently logged-in user has on this folder.
static int	getSortProperty(java.lang.String attribute_) Gets the (zero-based) index of the sort property referred to by the given attribute.
int	getType() Gets the type of this folder
java.lang.String	getUuid() Get the uuid of this process model folder.
boolean	isSpecial() Returns whether this is the special "My Models" folder.
void	setAncestorFolderIds(java.lang.Long[] ancestorFolderIds_) Sets the ancestor folder ids for this folder
void	setAncestorFolderNames(java.lang.String[] ancestorFolderNames_) Sets the ancestor folder names for this folder
void	setCreator(java.lang.String creator_) Sets the user who created this folder.
void	setDateCreated(java.sql.Timestamp dateCreated_) Sets the date on which this folder was created.
void	setDateModified(java.sql.Timestamp dateModified_) Sets the date on which this folder was modified.
void	setDescription(java.lang.String description_) Sets a description of this folder.
void	setNumberOfChildFolders(java.lang.Long numberOfChildFolders_) Sets the number of child folders that this folder has.
void	setNumberOfProcessModels(java.lang.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 be TypedVariable.PROCESSMODEL_FOLDER.
void	setParentFolderId(java.lang.Long parentFolderId_) Sets the parent of this folder.
void	setParentFolderName(java.lang.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 folder
void	setUuid(java.lang.String uuid) Set the uuid of this process model folder.
java.lang.String	toString() Returns a string representation of the Identity.

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

equals, getId, getName, hashCode, setId, setName

Methods inherited from class java.lang.Object

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

Field Detail

SORT_BY_ID

public static final java.lang.Integer SORT_BY_ID

Sort by the ID field

SORT_BY_NAME

public static final java.lang.Integer SORT_BY_NAME

Sort by the Name field

SORT_BY_DESCRIPTION

public static final java.lang.Integer SORT_BY_DESCRIPTION

Sort by the Description field

SORT_BY_PARENT_FOLDER_ID

public static final java.lang.Integer SORT_BY_PARENT_FOLDER_ID

Sort by the Parent Folder ID field

SORT_BY_PARENT_FOLDER_NAME

public static final java.lang.Integer SORT_BY_PARENT_FOLDER_NAME

Sort by the Parent Folder Name field

SORT_BY_NUMBER_PROCESS_MODELS

public static final java.lang.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 java.lang.Integer SORT_BY_DATE_CREATED

Sort by the Date Created field

SORT_BY_CREATOR

public static final java.lang.Integer SORT_BY_CREATOR

Sort by the Creator (username of the creator) field

SORT_BY_TYPE

public static final java.lang.Integer SORT_BY_TYPE

Sort by the Type field

SORT_BY_DATE_MODIFIED

public static final java.lang.Integer SORT_BY_DATE_MODIFIED

Sort by the Date Modified

SORT_BY_NUM_CHILD_FOLDERS

public static final java.lang.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:

Constant Field Values

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:

Constant Field Values

MY_MODELS_FOLDER_ID

public static final java.lang.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 Detail

ProcessModelFolder

public ProcessModelFolder()

ProcessModelFolder

public ProcessModelFolder(java.lang.String name)

Method Detail

getUuid

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

Get the uuid of this process model folder.

Overrides:

getUuid in class Identity

Returns:

The uuid.

See Also:

Identity.setUuid(String)

setUuid

public void setUuid(java.lang.String uuid)

Set the uuid of this process model folder.

Overrides:

setUuid in class Identity

Parameters:

uuid_ - The uuid.

See Also:

Identity.getUuid()

getAncestorFolderNames

public java.lang.String[] getAncestorFolderNames()

Gets the folder's ancestor folder names

Returns:

the names of the ancestor folders for this folder

setAncestorFolderNames

public void setAncestorFolderNames(java.lang.String[] ancestorFolderNames_)

Sets the ancestor folder names for this folder

Parameters:

ancestorFolderNames_ - the names to be set

See Also:

getAncestorFolderNames()

getAncestorFolderIds

public java.lang.Long[] getAncestorFolderIds()

Gets the folder's ancestor folder ids

Returns:

the ids of the folder's ancestor folders

setAncestorFolderIds

public void setAncestorFolderIds(java.lang.Long[] ancestorFolderIds_)

Sets the ancestor folder ids for this folder

Parameters:

ancestorFolderIds_ - the ids to set

See Also:

getAncestorFolderIds()

getNumberOfChildFolders

public java.lang.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(java.lang.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 java.lang.String getDescription()

Gets a description of this folder.

Returns:

a description of this folder.

setDescription

public void setDescription(java.lang.String description_)

Sets a description of this folder.

Parameters:

description_ - a description of this folder.

getParentFolderId

public java.lang.Long getParentFolderId()

Gets the parent of this folder.

Returns:

the id of the folder that contains this folder.

setParentFolderId

public void setParentFolderId(java.lang.Long parentFolderId_)

Sets the parent of this folder.

Parameters:

parentFolderId_ - the id of the folder that contains this folder.

getParentFolderName

public java.lang.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(java.lang.String parentFolderName_)

Sets the name of the parent of this folder.

Parameters:

parentFolderName_ - the id of the folder that contains this folder.

getNumberOfProcessModels

public java.lang.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(java.lang.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 java.sql.Timestamp getDateCreated()

Gets the date on which this folder was created.

Returns:

the date on which this folder was created.

setDateCreated

public void setDateCreated(java.sql.Timestamp dateCreated_)

Sets the date on which this folder was created.

Parameters:

dateCreated_ - the date on which this folder was created.

getDateModified

public java.sql.Timestamp getDateModified()

Gets the date on which this folder was modified.

Returns:

the date on which this folder was modified.

setDateModified

public void setDateModified(java.sql.Timestamp dateModified_)

Sets the date on which this folder was modified.

Parameters:

dateModified_ - the date on which this folder was modified.

getCreator

public java.lang.String getCreator()

Gets the user who created this folder.

Returns:

the username of the user who created this folder.

setCreator

public void setCreator(java.lang.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(java.lang.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 java.lang.String getNameEscapeJavascript()

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

toString

public java.lang.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