org.opencms.ui.apps

Interface I_CmsAppCategory

All Superinterfaces:

I_CmsHasOrder

All Known Subinterfaces:

I_CmsFolderAppCategory

All Known Implementing Classes:

CmsAppCategory, CmsCacheFolder, CmsDbManagerFolder, CmsFileHistoryFolder, CmsLinkValidationFolder

public interface I_CmsAppCategory
extends I_CmsHasOrder

App category interface.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getId() Returns the id.
java.lang.String	getName(java.util.Locale locale) Gets the user readable name for the category for a given locale.
java.lang.String	getParentId() Returns the parentId.
int	getPriority() Returns the priority.

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

getOrder

Method Detail

getId

java.lang.String getId()

Returns the id.

Returns:

the id

getName

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

Gets the user readable name for the category for a given locale.

Parameters:

locale - the locale for which to get the name

Returns:

the localized name

getParentId

java.lang.String getParentId()

Returns the parentId.

App categories can be nested. The method must return the id of the parent category if the category is nested. If it is on top level, null should be returned.

Returns:

the parentId

getPriority

int getPriority()

Returns the priority.

If more than one category with the same id is present, the one with higher priority is shown. The other categories with this id are discarded.

Returns:

the priority