flexagon.fd.model2.notification.pojos

Class NotifFolder

java.lang.Object

flexagon.ff.common.core.pojos.BasePOJO

flexagon.fd.model2.notification.pojos.NotifFolder

All Implemented Interfaces:

java.io.Serializable

public class NotifFolder
extends BasePOJO

Represents a FlexDeploy Folder or Application. For use within Notification Templates.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
NotifFolder() Creates a FlexDeploy folder.

Method Summary

Modifier and Type	Method and Description
void	addFolderToHierarchy(NotifFolder pFolder) Adds a folder to the linked list representing the hierarchy.
java.lang.String	getDescription() Returns the description for this folder.
java.util.LinkedList	getFolderHierarchy() Returns a linked list hierarchy of Folders contained in this folder.
java.util.List<java.lang.Long>	getFolderIdsAsList() Returns an ordered list of folder ids for this folders hierarchy.
java.lang.String	getFolderPath() Returns the qualified path of this folder in the hierarchy.
java.lang.Long	getId() Returns the internal generated identifier of this folder.
java.lang.String	getName() Returns the name of this folder.
java.lang.Long	getParentFolderId() Returns the internal identifier of the parent folder.
java.lang.String	getUrlPath() Returns the FlexDeploy UI relative URL for the folders page, which can be used to provide hyperlinks.
boolean	isActive() Returns whether this folder is active.
boolean	isApplication() Returns whether this folder represents an Application.
void	setActive(boolean pActive) Sets whether this folder is active or not.
void	setApplication(boolean pApplication) Sets whether this Folder represents an Application.
void	setDescription(java.lang.String pDescription) Sets the optional description for this Folder.
void	setFolderHierarchy(java.util.LinkedList pFolderHierarchy) Sets the hierarchy for the folder.
void	setFolderId(java.lang.Long pFolderId) Sets the folder id for this Folder.
void	setName(java.lang.String pName) Sets the name for this Folder.
void	setParentFolderId(java.lang.Long pParentFolderId) Sets the parent folder id for this Folder.

Methods inherited from class flexagon.ff.common.core.pojos.BasePOJO

areEqual, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

NotifFolder

public NotifFolder()

Creates a FlexDeploy folder.

Method Detail

setParentFolderId

public void setParentFolderId(java.lang.Long pParentFolderId)

Sets the parent folder id for this Folder. Null for the root folder.

Parameters:

pParentFolderId - The parent folder id.

getParentFolderId

public java.lang.Long getParentFolderId()

Returns the internal identifier of the parent folder.

Returns:

The internal generated identifier of the parent folder.

setFolderId

public void setFolderId(java.lang.Long pFolderId)

Sets the folder id for this Folder.

Parameters:

pFolderId - The folder id.

getId

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

public void setName(java.lang.String pName)

Sets the name for this Folder.

Parameters:

pName - The folder name.

getName

public java.lang.String getName()

Returns the name of this folder.

Returns:

The folder name.

setDescription

public void setDescription(java.lang.String pDescription)

Sets the optional description for this Folder.

Parameters:

pDescription - The folder description.

getDescription

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

public void setFolderHierarchy(java.util.LinkedList pFolderHierarchy)

Sets the hierarchy for the folder.

Parameters:

pFolderHierarchy - The folder hierarchy.

getFolderHierarchy

public java.util.LinkedList getFolderHierarchy()

Returns a linked list hierarchy of Folders contained in this folder.

Returns:

Linked list of folders with this folder.

addFolderToHierarchy

public void addFolderToHierarchy(NotifFolder pFolder)

Adds a folder to the linked list representing the hierarchy.

Parameters:

pFolder - The folder to add.

getFolderPath

public java.lang.String getFolderPath()

Returns the qualified path of this folder in the hierarchy.

Returns:

The qualified path of this folder.

getFolderIdsAsList

public java.util.List<java.lang.Long> getFolderIdsAsList()

Returns an ordered list of folder ids for this folders hierarchy.

Returns:

A list of folder ids within this folders hierarchy.

getUrlPath

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