org.nuxeo.ecm.platform.contentview.jsf
Interface ContentViewService

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

ContentViewServiceImpl

public interface ContentViewService
extends java.io.Serializable

Service handling content views and associated page providers.

Since:

5.4

Author:

Anahide Tchertchian

Method Summary

ContentView	getContentView(java.lang.String name) Returns the content view with given name, or null if not found.
java.util.Set<java.lang.String>	getContentViewNames() Returns all the registered content view names, or an empty set if no content view is registered.
java.util.Set<java.lang.String>	getContentViewNames(java.lang.String flag) Returns all the registered content view names with given flag declared on their definition
PageProvider<?>	getPageProvider(java.lang.String contentViewName, java.util.List<SortInfo> sortInfos, java.lang.Long pageSize, java.lang.Long currentPage, java.lang.Object... parameters) Returns the page provider computed from the content view with given name.

Method Detail

getContentView

ContentView getContentView(java.lang.String name)
                           throws ClientException

Returns the content view with given name, or null if not found.

Throws:

ClientException

getContentViewNames

java.util.Set<java.lang.String> getContentViewNames()

Returns all the registered content view names, or an empty set if no content view is registered.

getContentViewNames

java.util.Set<java.lang.String> getContentViewNames(java.lang.String flag)

Returns all the registered content view names with given flag declared on their definition

getPageProvider

PageProvider<?> getPageProvider(java.lang.String contentViewName,
                                java.util.List<SortInfo> sortInfos,
                                java.lang.Long pageSize,
                                java.lang.Long currentPage,
                                java.lang.Object... parameters)
                                throws ClientException

Returns the page provider computed from the content view with given name. Its properties are resolved using current FacesContext instance if they are EL Expressions.

If not null, parameters sortInfos and pageSize will override information computed in the XML file. If not null, currentPage will override default current page (0).

Throws:

ClientException