com.sssw.portal.api
Interface EbiPortalComponentInfo

All Superinterfaces:

Cloneable, EbiElement, EbiFrameworkElement, Serializable

public interface EbiPortalComponentInfo

extends EbiFrameworkElement

Generic interface for component information.

Field Summary

static String

EL_PORTAL_COMPONENT Component element type.

Method Summary

String	getComponentAlias() Deprecated. Use EbiPortalComponentInfo.getComponentName().
String[]	getComponentCategories() Gets component categories.
String	getComponentCategory() Deprecated. Use EbiPortalComponentInfo.getComponentCategories().
String	getComponentClassName() Gets the component class name.
String	getComponentDataDefinitionID() Gets the Device Profiling definition ID for the component.
String	getComponentDefaultStyleID() Gets the component default StyleID.
Properties	getComponentDefaultValues() Gets the component default values.
String	getComponentDescription() Gets the component description, which is defined in the deployment descriptor.
String	getComponentDescriptor() Gets the descriptor for the component.
String	getComponentDisplayName() Gets the component display name.
String[]	getComponentListRoles() Gets the list of roles authorized to list the component.
String	getComponentName() Gets the component name.
EbiComponentOptionInfo	getComponentOptionInfo(String optionID) Returns a specific option information, null if the component does not support the specified option.
EbiComponentOptionInfo[]	getComponentOptionInfoList() Returns list of supported options.
String	getComponentPreviewImage() Returns the value of the preview-image tag of the component descriptor
String	getComponentPreviewImage(EbiPortalContext context) Returns the URL to an image that represents the component as a runtime example.
String[]	getComponentRunRoles() Gets the list of roles authorized to run the component.
String[]	getComponentStyles() Gets component style list.
EbiPortalComponent	getInstance(EbiPortalContext context, Map params) Gets a component instance.
String	getPersonalizeURI() Deprecated. Use EbiPortalComponentInfo.getComponentOptionInfo(String optionID)
boolean	isComponentPersonalizable() Deprecated. Use EbiPortalComponentInfo.getComponentOptionInfo(String optionID).
boolean	isComponentServerLifetime() Gets the component lifetime flag.
boolean	isTitleBarEnabled() Gets the component enable title bar flag.

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_COMPONENT

public static final String EL_PORTAL_COMPONENT

Component element type.

Method Detail

getComponentClassName

public String getComponentClassName()

Gets the component class name.

Returns:

The component class name for the specified component.

getComponentDataDefinitionID

public String getComponentDataDefinitionID()

Gets the Device Profiling definition ID for the component.

Returns:

The component's data definition ID.

getComponentAlias

public String getComponentAlias()

Deprecated. Use EbiPortalComponentInfo.getComponentName().

Gets the component alias. The alias is optional.

Returns:

A Component alias for the specified component.

getComponentName

public String getComponentName()

Gets the component name. The component name is required.

Returns:

A Component name for the specified component.

getComponentCategory

public String getComponentCategory()

Deprecated. Use EbiPortalComponentInfo.getComponentCategories().

Gets a component category. The compoment category is optional. This method only returns the first category, use EbiPortalComponentInfo.getComponentCategories() to retrieve the entire list of categories this component belongs to.

Returns:

The category.

getComponentCategories

public String[] getComponentCategories()

Gets component categories.

Returns:

An array of categories.

getComponentStyles

public String[] getComponentStyles()

Gets component style list.

Returns:

An array of component styles.

getComponentDescriptor

public String getComponentDescriptor()

Gets the descriptor for the component.

Returns:

The descriptor of the component.

getComponentDisplayName

public String getComponentDisplayName()

Gets the component display name.

Returns:

The display name of the component.

getComponentDefaultStyleID

public String getComponentDefaultStyleID()

Gets the component default StyleID.

Returns:

The default StyleID for the component.

getComponentDescription

public String getComponentDescription()

Gets the component description, which is defined in the deployment descriptor.

Returns:

The description of the component.

getPersonalizeURI

public String getPersonalizeURI()

Deprecated. Use EbiPortalComponentInfo.getComponentOptionInfo(String optionID)

Gets the component personalize page location.

Returns:

URI of the page used to personalize this component.

isComponentPersonalizable

public boolean isComponentPersonalizable()

Deprecated. Use EbiPortalComponentInfo.getComponentOptionInfo(String optionID).

Gets the component personalizable flag.

Returns:

true if this component is allowed to be personalized, false otherwise.

isTitleBarEnabled

public boolean isTitleBarEnabled()

Gets the component enable title bar flag.

Returns:

true if the title bar for this component is enabled, false otherwise.

isComponentServerLifetime

public boolean isComponentServerLifetime()

Gets the component lifetime flag. The method returns false if the component should be instantiated on each request, true if the component is thread safe and can be shared by multiple requests.

getComponentDefaultValues

public Properties getComponentDefaultValues()

Gets the component default values.

Returns:

A Properties object that contains the component default configurations.

getInstance

public EbiPortalComponent getInstance(EbiPortalContext context,
                                      Map params)
                               throws EboUnrecoverableSystemException,
                                      EboSecurityException

Gets a component instance.

Parameters:

context - A portal context.

params - A set of parameters that is used to initialize this component instance.

Returns:

An EbiComponent object.

getComponentRunRoles

public String[] getComponentRunRoles()

Gets the list of roles authorized to run the component.

Returns:

An array of role names.

getComponentListRoles

public String[] getComponentListRoles()

Gets the list of roles authorized to list the component.

Returns:

An array of role names.

getComponentOptionInfoList

public EbiComponentOptionInfo[] getComponentOptionInfoList()

Returns list of supported options.

Returns:

An array of supported options

getComponentOptionInfo

public EbiComponentOptionInfo getComponentOptionInfo(String optionID)

Returns a specific option information, null if the component does not support the specified option.

Parameters:

optionID - the ID of the option to be returned.

getComponentPreviewImage

public String getComponentPreviewImage(EbiPortalContext context)

Returns the URL to an image that represents the component as a runtime example.

Parameters:

context - A portal context.

getComponentPreviewImage

public String getComponentPreviewImage()

Returns the value of the preview-image tag of the component descriptor

The string is retrieved from the component descriptor, no runtime substitutions are performed

Parameters:

context - A portal context.