Interface Perspective
public interface Perspective
Interface that provides information about a perspective.
- Since:
- 6.0.0
-
Method Summary
Modifier and TypeMethodDescriptionReturns the list of all allowed profiles of this perspective.Returns the action item that will be automatically selected when a user accesses this perspective.getDescription
(Locale aLocale) Returns the perspective description according to the given locale.Returns the perspective label according to the given locale.getName()
Returns the name of the perspective.Returns a list of all sections defined in this perspective.getTheme()
Returns the theme defined by this perspective.boolean
Returns true if this perspective is activated.boolean
Returns true if this perspective is the advanced perspective.boolean
isAllowedForProfile
(Profile aProfile, DirectoryHandler aDirectory) Returns true if this perspective is allowed for a given profile.
-
Method Details
-
getSectionItems
List<PerspectiveSectionItem> getSectionItems()Returns a list of all sections defined in this perspective. Returns an empty list if the perspective is the advanced one.- See Also:
-
getAllowedProfiles
Returns the list of all allowed profiles of this perspective. -
getDefaultActionItem
PerspectiveActionItem getDefaultActionItem()Returns the action item that will be automatically selected when a user accesses this perspective. -
getName
String getName()Returns the name of the perspective. -
isActivated
boolean isActivated()Returns true if this perspective is activated. -
isAdvanced
boolean isAdvanced()Returns true if this perspective is the advanced perspective. -
getLabel
Returns the perspective label according to the given locale. -
getDescription
Returns the perspective description according to the given locale. Returnsnull
if no description exists. -
isAllowedForProfile
Returns true if this perspective is allowed for a given profile. -
getTheme
PerspectiveTheme getTheme()Returns the theme defined by this perspective.
-