com.ibm.portal.wcm.plr
Interface BeanList

public interface BeanList

A list of resource beans provided by a BeanListProvider that can be rendered using the Pluggable Lists Rendering (PLR) Framework. BeanList instances may be cached by the PLR framework based on the CacheSpec values returned by the corresponding BeanListResponse objects that served the individual BeanList objects.

Since:

8.5.0.0

Note:

This interface is designed to be implemented by clients.

Method Summary

java.lang.Object	getListProperty(java.lang.String name) Returns an individual property of this bean list.
java.util.List<? extends ResourceBean>	getResourceBeans() Getter method for the read-only list of resource beans contained in this BeanList object.

Method Detail

getResourceBeans

java.util.List<? extends ResourceBean> getResourceBeans()

Getter method for the read-only list of resource beans contained in this BeanList object. The resource beans are typically loaded in the constructor implementation of the BeanList. This method must not trigger any logic that may cause exceptions. The returned list must not be modified by individual BeanListProvider implementations. BeanListResponse wrappers may be used to return a different list of resource beans than the one returned from a delegate BeanListProvider.

getListProperty

java.lang.Object getListProperty(java.lang.String name)
                                 throws BeanListProviderException

Returns an individual property of this bean list. This method will return null if the property is not available. The same BeanList object must always return the same value for the same list property name. Objects returned as String[] can be rendered as a list where the individual items can separated by a separator using the WCM [Plugin:ListRenderingContext separator=""] tag. Objects of type Date can be formatted in different date formats using the WCM [Plugin:ListRenderingContext format=""] tag.

Parameters:

name - the name of the property

Returns:

the list property.

Throws:

BeanListProviderException