|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ListRenderState
This interface represents the current values of the public render parameters defined by the pluggable list rendering framework:
filters
sorting
sources
The namesspace for these parameters is "http://www.ibm.com/xmlns/prod/datatype/content/resource-collections". The Web Content Viewer portlet declares those three render parameters such that corresponding parameters can be accessed directly via the Portlet API. The values used for these parameters need to adhere to the URI syntax.
Implementations of the BeanListProvider
interface may use the context information provided by this set of public render parameters to build their
provider specific execution context (for example, to construct the source URI from where to load the external data and to define how the data shall be sorted
and filtered.
The generic XML BeanListProvider (ibm.portal.ddc.xml
) supports the filters
parameter to make use of XSLT documents that define the
transformation of external XML data to the generic bean list data structure used by the pluggable list rendering framework. The generic XML BeanListProvider
also supports the sorting
parameter to determine the sort criteria and sort order, and it uses the sources
parameter to dynamically
determine the source URI used to load external XML data.
This interface is designed to be implemented by clients. |
Field Summary | |
---|---|
static java.lang.String |
NAMESPACE_URI
The namespace used for the public render parameters of the pluggable list rendering framework: "http://www.ibm.com/xmlns/prod/datatype/content/resource-collections" |
static javax.xml.namespace.QName |
QNAME_FILTERS
QName for the filters public render parameter. |
static javax.xml.namespace.QName |
QNAME_SORTING
QName for the sorting public render parameter. |
static javax.xml.namespace.QName |
QNAME_SOURCES
QName for the sources public render parameter. |
Method Summary | |
---|---|
java.util.List<Addressable> |
getFilters()
Returns the list of current filters as collected by the pluggable list rendering framework. |
java.util.List<Addressable> |
getSorting()
Returns the list of current sorting information as collected by the pluggable list rendering framework. |
java.util.List<Addressable> |
getSources()
Returns the list of current sources as collected by the pluggable list rendering framework. |
Field Detail |
---|
static final java.lang.String NAMESPACE_URI
static final javax.xml.namespace.QName QNAME_FILTERS
static final javax.xml.namespace.QName QNAME_SORTING
static final javax.xml.namespace.QName QNAME_SOURCES
Method Detail |
---|
java.util.List<Addressable> getFilters()
java.util.List<Addressable> getSorting()
java.util.List<Addressable> getSources()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |