com.sssw.portal.api
Interface EbiCategoryInfo

All Superinterfaces:

Cloneable, EbiElement, EbiFrameworkElement, Serializable

public interface EbiCategoryInfo

extends EbiFrameworkElement

This provides an interface to the CategoryInfo object.

Field Summary

static String

EL_PORTAL_CATEGORY category element type

Method Summary

String	getCategoryDescription() Gets description of the category.
String	getCategoryDescription(EbiPortalContext context) Gets the localized description of the category.
String	getCategoryDisplayName() Gets a category display name.
String	getCategoryDisplayName(EbiPortalContext context) Gets a category localized display name.
String	getCategoryName() Gets category name.
String	getCategoryType() Gets a category type.

Methods implemented from interface com.sssw.fw.api.EbiFrameworkElement

getElementUUID, getLastModified, getLastModifiedBy, isEqualTo, isReadOnly, resetReadOnly, setLastModified, setLastModifiedBy, setReadOnly

Methods implemented from interface com.sssw.fw.api.EbiElement

getType

Field Detail

EL_PORTAL_CATEGORY

public static final String EL_PORTAL_CATEGORY

category element type

Method Detail

getCategoryName

public String getCategoryName()

Gets category name.

Returns:

category name.

getCategoryDescription

public String getCategoryDescription()

Gets description of the category.

Returns:

a description of the category.

getCategoryDescription

public String getCategoryDescription(EbiPortalContext context)

Gets the localized description of the category.

Parameters:

context - the portal context

Returns:

a localized description of the category.

Since:

v5.0

getCategoryType

public String getCategoryType()

Gets a category type. (COMPONENT_CATEGORY, PAGE_CATEGORY, STYLE_CATEGORY, SHARED_PAGE_CATEGORY, CONTAINER_PAGE_CATEGORY OR PORTLET_REGISTRATION_CATEGORY)

Returns:

a category type.

getCategoryDisplayName

public String getCategoryDisplayName()

Gets a category display name.

Returns:

a the display name.

getCategoryDisplayName

public String getCategoryDisplayName(EbiPortalContext context)

Gets a category localized display name.

Parameters:

context - the portal context

Returns:

a the localized display name.

Since:

v5.0