public interface ContentViewService extends Serializable
Modifier and Type | Method and Description |
---|---|
ContentView |
getContentView(String name)
Returns the content view with given name, or null if not found.
|
ContentViewHeader |
getContentViewHeader(String name)
Returns the content view header, or null if not found.
|
Set<ContentViewHeader> |
getContentViewHeaders()
Returns all the registered content view headers, or an empty set if no
content view is registered.
|
Set<ContentViewHeader> |
getContentViewHeaders(String flag)
Returns all the registered content view headers with given flag declared
on their definition
|
Set<String> |
getContentViewNames()
Returns all the registered content view names, or an empty set if no
content view is registered.
|
Set<String> |
getContentViewNames(String flag)
Returns all the registered content view names with given flag declared
on their definition
|
PageProvider<?> |
getPageProvider(String contentViewName,
List<SortInfo> sortInfos,
Long pageSize,
Long currentPage,
Object... parameters)
Returns the page provider computed from the content view with given
name.
|
ContentView |
restoreContentView(ContentViewState contentViewState)
Restores a content view given a state.
|
ContentViewState |
saveContentView(ContentView contentView)
Returns the state of this content view.
|
ContentView getContentView(String name) throws ClientException
ClientException
ContentViewHeader getContentViewHeader(String name)
Set<String> getContentViewNames()
Set<ContentViewHeader> getContentViewHeaders()
Set<String> getContentViewNames(String flag)
Set<ContentViewHeader> getContentViewHeaders(String flag)
PageProvider<?> getPageProvider(String contentViewName, List<SortInfo> sortInfos, Long pageSize, Long currentPage, Object... parameters) throws ClientException
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).
ClientException
ContentViewState saveContentView(ContentView contentView)
This state can be used to restore the content view in another context.
contentView
- #restoreContentView(ContentViewState, CoreSession)
ContentView restoreContentView(ContentViewState contentViewState) throws ClientException
The core session is only useful when restoring a content view defining a page provider mapped to a document. It is used to initialize this document.
ClientException
saveContentView(ContentView)
Copyright © 2011 Nuxeo SA. All Rights Reserved.