org.bonitasoft.engine.profile

Interface ProfileEntry

All Superinterfaces:

BaseElement, BonitaObject, NamedElement, Serializable

public interface ProfileEntry
extends NamedElement, BaseElement

A ProfileEntry represents a menu entry (inside the main top menu bar) in the Bonita BPM 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

Method Summary

Methods

Modifier and Type	Method and Description
String	getDescription()
long	getIndex() The order of the profile entry in its context (at root level or inside its parent profile entry).
String	getPage()
long	getParentId()
long	getProfileId()
String	getType()
boolean	isCustom()

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

getName

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

getId

Method Detail

getParentId

long getParentId()

Returns:

the ID of the parent ProfileEntry.

getProfileId

long getProfileId()

Returns:

the ID of the profile that this profile entry belongs to.

getIndex

long getIndex()

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()

Returns:

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

getType

String getType()

Returns:

the type of the profile entry. It can be container (folder), or link to a real page.

getPage

String getPage()

Returns:

a unique reference to a page in the portal.

isCustom

boolean isCustom()

Returns:

true if this entry reference a custom page