public class PageReturnable extends Object implements Returnable, Serviceable, Configurable
Returnable
for Page
sModifier and Type | Field and Description |
---|---|
protected static String |
__PREFIX_ID
The prefix for the ids of facets and sorts
|
protected ContentHelper |
_contentHelper
The helper to handler contents
|
protected Returnable |
_contentReturnable
The content returnable
|
protected ContentTypesHelper |
_contentTypesHelper
The helper to handler content types
|
protected I18nizableText |
_label
The label
|
protected ServiceManager |
_manager
The service manager.
|
protected MetadataManager |
_metadataManager
Metadata manager.
|
protected ReturnableSaxer |
_saxer
The saxer
|
protected SiteManager |
_siteManager
The sites manager
|
static String |
ROLE
Avalon Role
|
Constructor and Description |
---|
PageReturnable() |
Modifier and Type | Method and Description |
---|---|
void |
configure(Configuration configuration) |
Query |
filterReturnedDocumentQuery(Collection<ContextQueriesWrapper> contextQueriesWrappers,
AdditionalParameterValueMap additionalParameterValues)
Returns the query to execute in order to filter returned objects (according to their type) during the search.
|
Collection<FacetDefinition> |
getFacets(AdditionalParameterValueMap additionalParameterValues)
Gets the facets
|
String |
getId()
Gets the id of the extension
|
I18nizableText |
getLabel()
Gets the label of the type of result
|
ReturnableSaxer |
getSaxer(Collection<Returnable> allReturnables,
AdditionalParameterValueMap additionalParameterValues)
Returns the
saxer responsible to SAX hits of this Returnable. |
Collection<SortDefinition> |
getSorts(AdditionalParameterValueMap additionalParameterValues)
Gets the sorts
|
boolean |
selectedByDefault()
Returns
true if the type must be selected by default |
void |
service(ServiceManager manager) |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
additionalServiceParameters, relationsWith
protected static final String __PREFIX_ID
protected SiteManager _siteManager
protected Returnable _contentReturnable
protected ContentTypesHelper _contentTypesHelper
protected ContentHelper _contentHelper
protected MetadataManager _metadataManager
protected ServiceManager _manager
protected I18nizableText _label
protected ReturnableSaxer _saxer
public PageReturnable()
public void service(ServiceManager manager) throws ServiceException
service
in interface Serviceable
ServiceException
public void configure(Configuration configuration) throws ConfigurationException
configure
in interface Configurable
ConfigurationException
public String getId()
Returnable
getId
in interface Returnable
public I18nizableText getLabel()
Returnable
getLabel
in interface Returnable
public boolean selectedByDefault()
Returnable
true
if the type must be selected by defaultselectedByDefault
in interface Returnable
true
if the type must be selected by defaultpublic Query filterReturnedDocumentQuery(Collection<ContextQueriesWrapper> contextQueriesWrappers, AdditionalParameterValueMap additionalParameterValues)
Returnable
ContextQueriesWrapper#getQuery
in order to make a JoinQuery
on interesting parts of ContextQueriesWrapper
s
and then constructs an AndQuery
composed of a DocumentTypeQuery
and the result of the call.filterReturnedDocumentQuery
in interface Returnable
contextQueriesWrappers
- The context queries
additionalParameterValues
- The additional parameter valuespublic ReturnableSaxer getSaxer(Collection<Returnable> allReturnables, AdditionalParameterValueMap additionalParameterValues)
Returnable
saxer
responsible to SAX hits of this Returnable.getSaxer
in interface Returnable
allReturnables
- All Returnable
s (including this)additionalParameterValues
- The additional parameter valuessaxer
responsible to SAX hits of this Returnable.public Collection<FacetDefinition> getFacets(AdditionalParameterValueMap additionalParameterValues)
Returnable
getFacets
in interface Returnable
additionalParameterValues
- The additional parameter valuespublic Collection<SortDefinition> getSorts(AdditionalParameterValueMap additionalParameterValues)
Returnable
getSorts
in interface Returnable
additionalParameterValues
- The additional parameter values