com.ibm.portal.wcm.plr
Interface BeanListRequest

All Superinterfaces:

BeanListProviderLookup

public interface BeanListRequest
extends BeanListProviderLookup

This interface represents a request for building a specific BeanListRequest object. BeanListRequest passed to delegate BeanListProvider objects may be wrapped to modify the execution context for the delegate bean list computation.

Since:

8.5.0.0

Note:

This interface is designed to be implemented by clients.

Method Summary

java.util.Map<? extends java.lang.String,java.lang.String>	getAttributes() Returns the read-only map of generic name value pairs.
Content	getContent() Returns the current content item providing the IBM Web Content Manager context for this list rendering.
Context	getContext() The request context triggering this bean list request.
java.lang.String	getExtensionID() Returns the BeanListProvider extension ID used to identify the initial BeanListProvider receiving this request.
ListRenderState	getListRenderState() Returns the set of current public render parameters supported by the PLR framework.
java.lang.String	getProfileName() Returns the unique name of the list rendering profile to be used for transforming external data into BeanList objects.

Methods inherited from interface com.ibm.portal.wcm.plr.BeanListProviderLookup

getBeanListProvider

Method Detail

getContext

Context getContext()

The request context triggering this bean list request. This context can be used to call other Portal APIs. For example, the context contained in BeanListRequest objects created during Web Content Viewer rendering are instances of the PortletContext interface which provides access to the current portlet request and response. This method never returns null.

Returns:

the current runtime context

getListRenderState

ListRenderState getListRenderState()

Returns the set of current public render parameters supported by the PLR framework. This method never returns null.

Returns:

the set of current public render parameters supported by the PLR framework. This method never returns null.

getContent

Content getContent()

Returns the current content item providing the IBM Web Content Manager context for this list rendering. This method may return null (e.g. in case this BeanListRequest was not triggered during Web Content Viewer rendering).

Returns:

the current content item providing the IBM Web Content Manager context for this list rendering.

getProfileName

java.lang.String getProfileName()

Returns the unique name of the list rendering profile to be used for transforming external data into BeanList objects. This value can be set using the profile parameter of the ListRenderingContext WCM rendering plugin ([Plugin:ListRenderingContext profile=""]). This value may be null in case no list rendering profile shall be applied.

Returns:

the unique name of the list rendering profile to be used for transforming external data into BeanList objects.

getAttributes

java.util.Map<? extends java.lang.String,java.lang.String> getAttributes()

Returns the read-only map of generic name value pairs. This map can be used to pass specific additional context information to the receiving BeanListProvider. The data contained in this map can be set using the attribute parameter of the ListRenderingContext WCM rendering plugin ([Plugin:ListRenderingContext attribute=""]). This method may return null.

The map must not be modified by individual BeanListProvider implementations. If the attributes shall be modified prior to passing the request to a delegate BeanListProvider, the BeanListRequest must be wrapped, and the request wrapper can return a different attributes map.

Returns:

the map of generic name value pairs.

getExtensionID

java.lang.String getExtensionID()

Returns the BeanListProvider extension ID used to identify the initial BeanListProvider receiving this request. This value can be set using the extension-id parameter of the ListRenderingContext WCM rendering plugin ([Plugin:ListRenderingContext extension-id=""]).

Returns:

the BeanListProvider extension ID used to identify the initial BeanListProvider receiving this request.