com.sssw.portal.api
Interface EbiComponentManager

public interface EbiComponentManager

Interface for the component manager.

Method Summary

EbiPortalComponent	getComponent(EbiPortalContext context, String componentID, Map params) Gets a component by specified component alias or classname.
EbiCategoryInfo	getComponentCategoryInfo(EbiPortalContext context, String category) Gets a component category information object.
EbiCategoryInfo	getComponentCategoryInfo(EbiPortalContext context, String categoryName, boolean flush) Gets a component category information object.
EbiCategoryInfo[]	getComponentCategoryInfoList(EbiPortalContext context) Gets a list of component category information objects.
String	getComponentDataDefinitionID(EbiPortalContext context, String componentID) Gets a compnent's data definition ID (for Device Profiling).
String	getComponentDefaultStyleID(EbiPortalContext context, String componentID) Gets a component default style ID.
EbiPortalComponentInfo	getComponentInfo(EbiPortalContext context, String componentID, boolean flush) Gets a component info object that provides persistent component information.
EbiPortalComponentInfo[]	getComponentInfoList(EbiPortalContext context) Gets the entire list of component information objects.
EbiPortalComponentInfo[]	getComponentInfoList(EbiPortalContext context, String category) Deprecated. To get the entire list of options use EbiComponentManager.getComponentInfoList(EbiPortalContext context). To get a list of components by category use EbiComponentManager.getComponentInfoListByCategory(EbiPortalContext context, String category)
EbiPortalComponentInfo[]	getComponentInfoListByCategory(EbiPortalContext context, String category) Gets a list of component information objects by category.
EbiPortalComponentInfo[]	getComponentListByMediaType(EbiPortalContext context, String mediaType) Gets a list of component info objects for a specified media type.
String	getComponentParameter(EbiPortalContext context, String name, String paramKey, Map params) Gets a component parameter, either from the instance parameters or from the component's default definition.
EbiPortalComponentInfo[]	getRestrictedComponentInfoList(EbiPortalContext context) Gets a list of all components for the Principal specified from the context.
EbiPortalComponentInfo[]	getRestrictedComponentInfoList(EbiPortalContext context, String category) Gets a list of components for the Principal specified from the context.
EbiComponentOptionInfo[]	getRestrictedOptionInfoList(EbiPortalContext context, String componentID) Gets the list of options for a component that the current user has access to.

Method Detail

getComponentInfo

public EbiPortalComponentInfo getComponentInfo(EbiPortalContext context,
                                               String componentID,
                                               boolean flush)
                                        throws EboUnrecoverableSystemException

Gets a component info object that provides persistent component information. Component information is retrieved from component deployment descriptor.

Parameters:

context - A context object that contains session/user information.

componentID - The name of the specified component.

flush - If set to true, always re-retrieves persistent data.

Returns:

An EbiComponentInfo object.

getComponent

public EbiPortalComponent getComponent(EbiPortalContext context,
                                       String componentID,
                                       Map params)
                                throws EboUnrecoverableSystemException,
                                       EboSecurityException

Gets a component by specified component alias or classname. If the component instance does not already exist, it instantiates one.

Parameters:

context - A portal context object that contains session/user information.

componentID - A component ID.

params - A set of parameters for initializing the component.

Returns:

An EbiComponent object.

getComponentInfoList

public EbiPortalComponentInfo[] getComponentInfoList(EbiPortalContext context,
                                                     String category)
                                              throws EboUnrecoverableSystemException

Deprecated. To get the entire list of options use EbiComponentManager.getComponentInfoList(EbiPortalContext context). To get a list of components by category use EbiComponentManager.getComponentInfoListByCategory(EbiPortalContext context, String category)

Gets a list of Component information objects for a category.

Parameters:

context - A context object that contains session/user information.

category - A category. If this parameter is null, all components are retrieved.

Returns:

An array of EbiPortalComponentInfo objects.

getComponentInfoList

public EbiPortalComponentInfo[] getComponentInfoList(EbiPortalContext context)
                                              throws EboUnrecoverableSystemException

Gets the entire list of component information objects.

Parameters:

context - A context object.

Returns:

an array of EbiPortalComponentInfo objects.

Throws:

EboUnrecoverableSystemException -

getComponentInfoListByCategory

public EbiPortalComponentInfo[] getComponentInfoListByCategory(EbiPortalContext context,
                                                               String category)
                                                        throws EboUnrecoverableSystemException

Gets a list of component information objects by category.

If category is null, all components without any category assigned will be returned.

Parameters:

context - A context object.

category - A category ID.

Returns:

an array of EbiPortalComponentInfo objects.

Throws:

EboUnrecoverableSystemException -

getComponentListByMediaType

public EbiPortalComponentInfo[] getComponentListByMediaType(EbiPortalContext context,
                                                            String mediaType)
                                                     throws EboUnrecoverableSystemException

Gets a list of component info objects for a specified media type.

Parameters:

context - A context object that contains session/user information.

mediaType - A specified media type.

media type is equivalent to user agent in this context A style may have the following descriptor:

   PhoneListStyle
   Phone List Style
   
	    
		    Generic_HTML
			PhoneList_HTML.xsl
	    
	    
		    Generic_WML
		    PhoneList_WML.xsl
		    PhoneList_WML.xsl
	    
  

This style is represented by two media types Generic_HTML and Generic_WML A component that references this style uses both of these media types.

Returns:

An array of EbiPortalComponentInfo objects.

getRestrictedComponentInfoList

public EbiPortalComponentInfo[] getRestrictedComponentInfoList(EbiPortalContext context,
                                                               String category)
                                                        throws EboUnrecoverableSystemException

Gets a list of components for the Principal specified from the context.

Parameters:

context - A portal context.

category - The name of a category. If this parameter is null, return all components that are uncategorized.

getRestrictedComponentInfoList

public EbiPortalComponentInfo[] getRestrictedComponentInfoList(EbiPortalContext context)
                                                        throws EboUnrecoverableSystemException

Gets a list of all components for the Principal specified from the context.

Parameters:

context - a portal context.

Returns:

list of components that the current user can see in a select list

Throws:

EboUnrecoverableSystemException -

See Also:

EbiComponentManager.getRestrictedComponentInfoList(EbiPortalContext)

getComponentParameter

public String getComponentParameter(EbiPortalContext context,
                                    String name,
                                    String paramKey,
                                    Map params)
                             throws EboUnrecoverableSystemException

Gets a component parameter, either from the instance parameters or from the component's default definition.

Parameters:

context - A context object that contains session/user information.

componentID - A component ID.

paramKey -

params - A Map of the passed in component parameters.

getComponentDefaultStyleID

public String getComponentDefaultStyleID(EbiPortalContext context,
                                         String componentID)
                                  throws EboUnrecoverableSystemException

Gets a component default style ID.

Parameters:

context - A context object that contains session/user information.

componentID - A component ID.

Returns:

The component's default style ID.

getComponentDataDefinitionID

public String getComponentDataDefinitionID(EbiPortalContext context,
                                           String componentID)
                                    throws EboUnrecoverableSystemException

Gets a compnent's data definition ID (for Device Profiling).

Parameters:

context - A context object that contains session/user information.

name - A component ID.

Returns:

The component's data definition ID.

getComponentCategoryInfo

public EbiCategoryInfo getComponentCategoryInfo(EbiPortalContext context,
                                                String categoryName,
                                                boolean flush)
                                         throws EboUnrecoverableSystemException

Gets a component category information object.

Parameters:

context - A context object that contains session/user information.

categoryName - The name of a category.

flush - True if it should re-retrieve component category info from database.

Returns:

An EbiCategoryInfo object.

getComponentCategoryInfo

public EbiCategoryInfo getComponentCategoryInfo(EbiPortalContext context,
                                                String category)
                                         throws EboUnrecoverableSystemException

Gets a component category information object. If the object is available in the cache, this object is returned.

Parameters:

context - A context object that contains session/user information.

category - The name of a category.

Returns:

An EbiCategoryInfo object.

getComponentCategoryInfoList

public EbiCategoryInfo[] getComponentCategoryInfoList(EbiPortalContext context)
                                               throws EboUnrecoverableSystemException

Gets a list of component category information objects.

Parameters:

context - A context object that contains session/user information.

Returns:

An array of EbiCategoryInfo objects for component categories.

getRestrictedOptionInfoList

public EbiComponentOptionInfo[] getRestrictedOptionInfoList(EbiPortalContext context,
                                                            String componentID)
                                                     throws EboUnrecoverableSystemException

Gets the list of options for a component that the current user has access to.

This list is used by the caller in order to construct the title bar. The list of options includes all options for a particular component that match the following criteria:

• A user has access to the list role of the option for the component.
• The current state of the component is not a hide state specified by the option descriptor.

Parameters:

context - A portal context.

componentID - A component ID.

Returns:

an array of component option infos

Throws:

EboUnrecoverableSystemException -