com.ibm.portal.wcm.plr
Interface BeanListResponse

public interface BeanListResponse

This interface represents the result for a specific BeanListRequest object. The BeanList object returned by this response can be rendered using the Pluggable List Rendering (PLR) feature. BeanListResponse objects returned by delegate BeanListProvider objects may be wrapped to modify the overall bean list request result. While individual BeanList objects returned by the getBeanList() method may be cached by the PLR framework, BeanListResponse objects are never cached.

Since:

8.5.0.0

See Also:

BeanListRequest

Note:

This interface is designed to be implemented by clients.

Method Summary

BeanList	getBeanList() Returns the BeanList object computed for this response.
CacheSpec	getCacheSpec() Returns information on how the BeanList object provided with this response can be cached.

Method Detail

getCacheSpec

CacheSpec getCacheSpec()
                       throws BeanListProviderException

Returns information on how the BeanList object provided with this response can be cached. This method may return null if the BeanList object returned by the getBeanList() method shall not be cached by the PLR feature.

Returns:

the caching specification for the BeanList object provided by this BeanListResponse.

Throws:

BeanListProviderException

getBeanList

BeanList getBeanList()
                     throws BeanListProviderException

Returns the BeanList object computed for this response. This method is only invoked if the BeanList object was not found in the cache based on theCacheSpec value obtained via the getCacheSpec() method. Cached BeanList objects may be accessed by multiple threads in parallel.

Returns:

the BeanList object provided by thisBeanListResponse.

Throws:

BeanListProviderException