Class NotifFolder
java.lang.Object
flexagon.ff.common.core.pojos.BasePOJO
flexagon.fd.model2.notification.pojos.NotifFolder
- All Implemented Interfaces:
Serializable
Represents a FlexDeploy Folder or Application. For use within Notification Templates.
- See Also:
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoidaddFolderToHierarchy(NotifFolder pFolder) Adds a folder to the linked list representing the hierarchy.Returns the description for this folder.Returns a linked list hierarchy of Folders contained in this folder.Returns an ordered list of folder ids for this folders hierarchy.Returns the qualified path of this folder in the hierarchy.getId()Returns the internal generated identifier of this folder.getName()Returns the name of this folder.Returns the internal identifier of the parent folder.Returns the FlexDeploy UI relative URL for the folders page, which can be used to provide hyperlinks.booleanisActive()Returns whether this folder is active.booleanReturns whether this folder represents an Application.voidsetActive(boolean pActive) Sets whether this folder is active or not.voidsetApplication(boolean pApplication) Sets whether this Folder represents an Application.voidsetDescription(String pDescription) Sets the optional description for this Folder.voidsetFolderHierarchy(LinkedList pFolderHierarchy) Sets the hierarchy for the folder.voidsetFolderId(Long pFolderId) Sets the folder id for this Folder.voidSets the name for this Folder.voidsetParentFolderId(Long pParentFolderId) Sets the parent folder id for this Folder.
-
Constructor Details
-
NotifFolder
public NotifFolder()Creates a FlexDeploy folder.
-
-
Method Details
-
setParentFolderId
Sets the parent folder id for this Folder. Null for the root folder.- Parameters:
pParentFolderId- The parent folder id.
-
getParentFolderId
Returns the internal identifier of the parent folder.- Returns:
- The internal generated identifier of the parent folder.
-
setFolderId
Sets the folder id for this Folder.- Parameters:
pFolderId- The folder id.
-
getId
Returns the internal generated identifier of this folder.- Returns:
- The internal generated identifier of this folder.
-
setActive
public void setActive(boolean pActive) Sets whether this folder is active or not.- Parameters:
pActive- Whether the folder is active.
-
isActive
public boolean isActive()Returns whether this folder is active.- Returns:
- Whether this folder is active.
-
setName
Sets the name for this Folder.- Parameters:
pName- The folder name.
-
getName
Returns the name of this folder.- Returns:
- The folder name.
-
setDescription
Sets the optional description for this Folder.- Parameters:
pDescription- The folder description.
-
getDescription
Returns the description for this folder.- Returns:
- The folder description.
-
setApplication
public void setApplication(boolean pApplication) Sets whether this Folder represents an Application. Default is false.- Parameters:
pApplication- The parent folder id.
-
isApplication
public boolean isApplication()Returns whether this folder represents an Application. True for Application, False for Folder.- Returns:
- Whether this folder is an Application.
-
setFolderHierarchy
Sets the hierarchy for the folder.- Parameters:
pFolderHierarchy- The folder hierarchy.
-
getFolderHierarchy
Returns a linked list hierarchy of Folders contained in this folder.- Returns:
- Linked list of folders with this folder.
-
addFolderToHierarchy
Adds a folder to the linked list representing the hierarchy.- Parameters:
pFolder- The folder to add.
-
getFolderPath
Returns the qualified path of this folder in the hierarchy.- Returns:
- The qualified path of this folder.
-
getFolderIdsAsList
Returns an ordered list of folder ids for this folders hierarchy.- Returns:
- A list of folder ids within this folders hierarchy.
-
getUrlPath
Returns the FlexDeploy UI relative URL for the folders page, which can be used to provide hyperlinks.- Returns:
- The FlexDeploy UI relative URL for the folders page, which can be used to provide hyperlinks.
-