org.bonitasoft.engine.profile

Interface ProfileEntry

All Superinterfaces:

BaseElement, BonitaObject, NamedElement, Serializable

All Known Implementing Classes:

ProfileEntryImpl

public interface ProfileEntry
extends NamedElement, BaseElement

A ProfileEntry represents a menu entry (inside the main top menu bar) in the Bonita Portal. It can be a container (that contains other profile entries) or a link to a page in the portal. ProfileEntrys are ordered inside a containing profile entry or at the root level.

Author:

Celine Souchet, Emmanuel Duchastenier, Julien Mege, Anthony Birembaut

Field Summary

Fields

Modifier and Type	Field and Description
static String	FOLDER_TYPE Constant for "folder" type of profile entries (used to create a group of menu link)
static String	LINK_TYPE Constant for "link" type of profile entries (used to create a link to a page in the menu)

Method Summary

Modifier and Type	Method and Description
String	getDescription() Retrieves the ProfileEntry description, that can be used to describe the link of the containing folder it represents, according to its type.
long	getIndex() Retrieves the order of the profile entry in its context (at root level or inside its parent profile entry).
String	getPage() Retrieves the unique name of the page referenced by this ProfileEntry.
long	getParentId() Retrieves the identifier of the parent ProfileEntry.
long	getProfileId() Retrieves the identifier of the related Profile
String	getType() Retrieves the ProfileEntry type.
boolean	isCustom() Determines if the referenced page is a custom Page.

Methods inherited from interface org.bonitasoft.engine.bpm.NamedElement

getName

Methods inherited from interface org.bonitasoft.engine.bpm.BaseElement

getId

Field Detail

FOLDER_TYPE

static final String FOLDER_TYPE

Constant for "folder" type of profile entries (used to create a group of menu link)

See Also:

Constant Field Values

LINK_TYPE

static final String LINK_TYPE

Constant for "link" type of profile entries (used to create a link to a page in the menu)

See Also:

Constant Field Values

Method Detail

getParentId

long getParentId()

Retrieves the identifier of the parent ProfileEntry.

Returns:

the identifier of the parent ProfileEntry.

getProfileId

long getProfileId()

Retrieves the identifier of the related Profile

Returns:

the identifier of the related Profile

getIndex

long getIndex()

Retrieves the order of the profile entry in its context (at root level or inside its parent profile entry).

Returns:

the index of the profile entry.

getDescription

String getDescription()

Retrieves the ProfileEntry description, that can be used to describe the link of the containing folder it represents, according to its type.

Returns:

the ProfileEntry description

getType

String getType()

Retrieves the ProfileEntry type. It can be container (folder), or link to a real page.

Returns:

the ProfileEntry type

getPage

String getPage()

Retrieves the unique name of the page referenced by this ProfileEntry. It can be a portal page or a custom Page.

Returns:

the unique name of the page referenced by this ProfileEntry

See Also:

Page.getName()

isCustom

boolean isCustom()

Determines if the referenced page is a custom Page.

Returns:

true if this ProfileEntry references a custom Page; false if it references a portal page.

See Also:

Page