PlaceableDefinition Interface

com.bea.netuix.application.definition
PlaceableDefinition Interface

public interface PlaceableDefinition

Represents entities that may be placed on other entities. E.g. Books and Portlets.


All Known Implementing Classes
PortletDefinition, BookDefinition

Method Summary

public String
getDefinitionLabel()
Returns the definition label associated with this PlaceableDefinition.
public String
getDescription()
Returns the description associated with this PlaceableDefinition.
public LocalizationResource
getLocalizationResource()
Returns the LocalizationResource associated with this placeable based on the locale of the request used for retrieving the menu.
public PlaceableDefinitionId
getPlaceableDefinitionId()
Returns a PlaceableDefinitionId associated with this PlaceableDefinition.
public String
getTitle()
Returns the title associated with this PlaceableDefinition.
public String
getWebAppName()
Returns the name of the J2EE web application this PlaceableDefinition is scoped to.

Method Detail

getDefinitionLabel() Method

public String getDefinitionLabel()
Returns the definition label associated with this PlaceableDefinition.

Returns

definition label

getDescription() Method

public String getDescription()
Returns the description associated with this PlaceableDefinition.

Returns

description

getLocalizationResource() Method

public LocalizationResource getLocalizationResource()
Returns the LocalizationResource associated with this placeable based on the locale of the request used for retrieving the menu.

Returns

LocalizationResource associated with this placeable

getPlaceableDefinitionId() Method

public PlaceableDefinitionId getPlaceableDefinitionId()
Returns a PlaceableDefinitionId associated with this PlaceableDefinition. May return NULL if the PlaceableDefinition has not been retrieved using the persistence API

Returns

PlaceableDefinitionId

getTitle() Method

public String getTitle()
Returns the title associated with this PlaceableDefinition.

Returns

title

getWebAppName() Method

public String getWebAppName()
Returns the name of the J2EE web application this PlaceableDefinition is scoped to.

Returns

web application name