Package org.opencms.ui.apps

Interface I_CmsWorkplaceAppConfiguration

All Superinterfaces:

I_CmsHasOrder

All Known Implementing Classes:

A_CmsWorkplaceAppConfiguration, CmsAccountsAppConfiguration, CmsAppHierarchyConfiguration, CmsBroadCastConfigurtion, CmsCacheAdminConfiguration, CmsCacheViewFlexConfiguration, CmsCacheViewImageConfiguration, CmsDateSearchConfiguration, CmsDbExportConfiguration, CmsDbImportHTTPConfiguration, CmsDbImportServerConfiguration, CmsDbManagerConfiguration, CmsDbPropertiesAppConfiguration, CmsDbRemovePubLocksConfiguration, CmsDbStaticExportConfiguration, CmsDbSynchronizationConfiguration, CmsEditorConfiguration, CmsFileExplorerConfiguration, CmsFileHistoryConfiguration, CmsGitAppConfiguration, CmsLegacyAppConfiguration, CmsLinkInFolderValidationConfiguration, CmsLinkValidationConfiguration, CmsLinkValidationExternalConfiguration, CmsListManagerConfiguration, CmsLogFileConfiguration, CmsModuleAppConfiguration, CmsPageEditorConfiguration, CmsProjectManagerConfiguration, CmsProjectOverviewConfiguration, CmsPublishQueueConfiguration, CmsQuickLaunchEditorConfiguration, CmsResourceTypeAppConfiguration, CmsScheduledJobsAppConfig, CmsSearchindexAppConfiguration, CmsShellAppConfiguration, CmsSiteManagerConfiguration, CmsSitemapEditorConfiguration, CmsSourceSearchAppConfiguration, CmsSqlConsoleAppConfiguration, CmsUnusedContentFinderConfiguration, CmsUserDataAppConfiguration

public interface I_CmsWorkplaceAppConfiguration
extends I_CmsHasOrder

Contains the configuration of a single workplace app.

Field Summary

Fields

Modifier and Type	Field	Description
static int	DEFAULT_PRIORIY	Default priority.

Method Summary

Modifier and Type	Method	Description
java.lang.String	getAppCategory()	Gets the id of the app category in which this app should be displayed (null for the root category).
I_CmsWorkplaceApp	getAppInstance()	Returns a new app instance.
java.lang.String	getButtonStyle()	Returns the button style.
java.lang.String	getHelpText(java.util.Locale locale)	Gets the help text for the app in the given locale.
com.vaadin.server.Resource	getIcon()	Returns the app icon resource.
java.lang.String	getId()	Returns the unique app id.
java.lang.String	getName(java.util.Locale locale)	Returns the display name of the app.
int	getPriority()	Gets the priority of the app configuration.
CmsRole	getRequiredRole()	Returns the user role required for this app.
CmsAppVisibilityStatus	getVisibility(CmsObject cms)	Returns the visibility status of the app for the given user context.

Methods inherited from interface org.opencms.ui.apps.I_CmsHasOrder

getOrder

Field Detail

DEFAULT_PRIORIY

static final int DEFAULT_PRIORIY

Default priority.

See Also:

Constant Field Values

Method Detail

getAppCategory

java.lang.String getAppCategory()

Gets the id of the app category in which this app should be displayed (null for the root category).

Returns:

the app category id

getAppInstance

I_CmsWorkplaceApp getAppInstance()

Returns a new app instance.

Returns:

a new app instance

getButtonStyle

java.lang.String getButtonStyle()

Returns the button style.

Returns:

the button style

getHelpText

java.lang.String getHelpText(java.util.Locale locale)

Gets the help text for the app in the given locale.

Parameters:

locale - the locale to use

Returns:

the help text

getIcon

com.vaadin.server.Resource getIcon()

Returns the app icon resource.

Returns:

the icon resource

getId

java.lang.String getId()

Returns the unique app id.

Returns:

the app id

getName

java.lang.String getName(java.util.Locale locale)

Returns the display name of the app.

Parameters:

locale - the user locale

Returns:

the app name

getPriority

int getPriority()

Gets the priority of the app configuration.

Between two apps with the same id and different priorities, the one with the higher priority will override the one with the lower priority.

Returns:

the priority

getRequiredRole

CmsRole getRequiredRole()

Returns the user role required for this app.

Returns:

the required user role

getVisibility

CmsAppVisibilityStatus getVisibility(CmsObject cms)

Returns the visibility status of the app for the given user context.

Parameters:

cms - the user context

Returns:

the visibility status