|
Novell exteNd Director 5.2 API |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
EbiPortletInfoManager
This provides an interface for the component manager.
Method Summary | |
EbiPortalComponent |
getComponent(EbiPortalContext context,
String componentID,
Map params)
Deprecated. Gets a component by specified component alias or classname. |
EbiCategoryInfo |
getComponentCategoryInfo(EbiPortalContext context,
String category)
Deprecated. Gets a component category information object. |
EbiCategoryInfo |
getComponentCategoryInfo(EbiPortalContext context,
String categoryName,
boolean flush)
Deprecated. Gets a component category information object. |
EbiCategoryInfo[] |
getComponentCategoryInfoList(EbiPortalContext context)
Deprecated. Gets a list of component category information objects. |
String |
getComponentDataDefinitionID(EbiPortalContext context,
String componentID)
Deprecated. Gets a compnent's data definition ID (for Device Profiling). |
String |
getComponentDefaultStyleID(EbiPortalContext context,
String componentID)
Deprecated. Gets a component default style ID. |
EbiPortalComponentInfo |
getComponentInfo(EbiPortalContext context,
String componentID,
boolean flush)
Deprecated. Gets a component info object that provides persistent component information. |
EbiPortalComponentInfo[] |
getComponentInfoList(EbiPortalContext context)
Deprecated. 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)
Deprecated. Gets a list of component information objects by category. |
EbiPortalComponentInfo[] |
getComponentListByMediaType(EbiPortalContext context,
String mediaType)
Deprecated. Gets a list of component info objects for a specified media type. |
String |
getComponentParameter(EbiPortalContext context,
String name,
String paramKey,
Map params)
Deprecated. Gets a component parameter, either from the instance parameters or from the component's default definition. |
EbiPortalComponentInfo[] |
getRestrictedComponentInfoList(EbiPortalContext context)
Deprecated. Gets a list of all components for the Principal specified from the context. |
EbiPortalComponentInfo[] |
getRestrictedComponentInfoList(EbiPortalContext context,
String category)
Deprecated. Gets a list of components for the Principal specified from the context. |
EbiComponentOptionInfo[] |
getRestrictedOptionInfoList(EbiPortalContext context,
String componentID)
Deprecated. Gets the list of options for a component that the current user has access to. |
Method Detail |
public EbiPortalComponentInfo getComponentInfo(EbiPortalContext context, String componentID, boolean flush) throws EboUnrecoverableSystemException
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.public EbiPortalComponent getComponent(EbiPortalContext context, String componentID, Map params) throws EboUnrecoverableSystemException, EboSecurityException
context
- A portal context object that contains session/user information.componentID
- A component ID.params
- A set of parameters for initializing the component.public EbiPortalComponentInfo[] getComponentInfoList(EbiPortalContext context, String category) throws EboUnrecoverableSystemException
EbiComponentManager.getComponentInfoList(EbiPortalContext context)
.
To get a list of
components by category use
EbiComponentManager.getComponentInfoListByCategory(EbiPortalContext context, String category)
context
- A context object that contains session/user information.category
- A category. If this parameter is null, all components are retrieved.public EbiPortalComponentInfo[] getComponentInfoList(EbiPortalContext context) throws EboUnrecoverableSystemException
context
- A context object.public EbiPortalComponentInfo[] getComponentInfoListByCategory(EbiPortalContext context, String category) throws EboUnrecoverableSystemException
If category is null, all components without any category assigned will be returned.
context
- A context object.category
- A category ID.public EbiPortalComponentInfo[] getComponentListByMediaType(EbiPortalContext context, String mediaType) throws EboUnrecoverableSystemException
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.
public EbiPortalComponentInfo[] getRestrictedComponentInfoList(EbiPortalContext context, String category) throws EboUnrecoverableSystemException
context
- A portal context.category
- The name of a category. If this parameter is null, return all components that are uncategorized.public EbiPortalComponentInfo[] getRestrictedComponentInfoList(EbiPortalContext context) throws EboUnrecoverableSystemException
context
- a portal context.EbiComponentManager.getRestrictedComponentInfoList(EbiPortalContext)
public String getComponentParameter(EbiPortalContext context, String name, String paramKey, Map params) throws EboUnrecoverableSystemException
context
- A context object that contains session/user information.componentID
- A component ID.paramKey
- params
- A Map of the passed in component parameters.public String getComponentDefaultStyleID(EbiPortalContext context, String componentID) throws EboUnrecoverableSystemException
context
- A context object that contains session/user information.componentID
- A component ID.public String getComponentDataDefinitionID(EbiPortalContext context, String componentID) throws EboUnrecoverableSystemException
context
- A context object that contains session/user information.name
- A component ID.public EbiCategoryInfo getComponentCategoryInfo(EbiPortalContext context, String categoryName, boolean flush) throws EboUnrecoverableSystemException
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.public EbiCategoryInfo getComponentCategoryInfo(EbiPortalContext context, String category) throws EboUnrecoverableSystemException
context
- A context object that contains session/user information.category
- The name of a category.public EbiCategoryInfo[] getComponentCategoryInfoList(EbiPortalContext context) throws EboUnrecoverableSystemException
context
- A context object that contains session/user information.public EbiComponentOptionInfo[] getRestrictedOptionInfoList(EbiPortalContext context, String componentID) throws EboUnrecoverableSystemException
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:
context
- A portal context.componentID
- A component ID.
|
Novell exteNd Director 5.2 API |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |