com.ibm.portal.wcm.plr
Interface BeanListProvider
-
public interface BeanListProvider
This is the generic BeanListProvider interface to be implemented by custom extensions to the
Pluggable List Rendering (PLR) framework.
Individual extensions can be registered with the Extension Registry using the ID com.ibm.portal.wcm.plr.BeanListProvider.
The name of the class attribute used for instantiating individual extensions is class.
Individual BeanListProvider are instantiated once and kept as singletons by the PLR framework.
- Since:
- 8.5.0.0
- Note:
This interface is designed to be implemented by clients. |
Field Summary
|
static java.lang.String |
ATTR_CLASS
Name of the class attribute used for instantiation |
static java.lang.String |
EXTENSION_POINT_ID
Extension point ID for the Pluggable List Rendering Extension point: com.ibm.portal.wcm.plr.BeanListProvider |
ATTR_CLASS
static final java.lang.String ATTR_CLASS
- Name of the class attribute used for instantiation
- See Also:
- Constant Field Values
EXTENSION_POINT_ID
static final java.lang.String EXTENSION_POINT_ID
- Extension point ID for the Pluggable List Rendering Extension point: com.ibm.portal.wcm.plr.BeanListProvider
- See Also:
- Constant Field Values
getBeanList
BeanListResponse getBeanList(BeanListRequest request)
throws BeanListProviderException
- Returns the bean list response for a specific bean list request.
The BeanListResponse returned by this method provides access to the actual BeanList object which may be cached by the PLR framework.
The BeanListResponse objects themselves are never cached by the PLR framework.
- Parameters:
- request - the specific bean list request
- Returns:
- the bean list response to the given bean list request
- Throws:
- BeanListProviderException - if the specified bean list request cannot be processed
getExtensionID
java.lang.String getExtensionID()
- Returns the ID of this extension. This ID is matched against the extension-id attribute of the [Plugin:ListRenderingContext extension-id=""] WCM tag.
- Returns:
- the ID of this extension