org.nuxeo.ecm.platform.faceted.search.jsf.localconfiguration

Class FacetedSearchConfigurationAdapter

java.lang.Object

org.nuxeo.ecm.core.api.localconfiguration.AbstractLocalConfiguration<FacetedSearchConfiguration>

org.nuxeo.ecm.platform.faceted.search.jsf.localconfiguration.FacetedSearchConfigurationAdapter

All Implemented Interfaces:

DetachedAdapter, LocalConfiguration<FacetedSearchConfiguration>, FacetedSearchConfiguration

public class FacetedSearchConfigurationAdapter
extends AbstractLocalConfiguration<FacetedSearchConfiguration>
implements FacetedSearchConfiguration

Default implementation of FacetedSearchConfiguration

Since:

5.4.2

Author:

Arnaud Kervern

Constructor Summary

Constructors

Constructor and Description
FacetedSearchConfigurationAdapter(DocumentModel doc)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canMerge() Returns true if this LocalConfiguration accepted to be merged with a parent configuration, false otherwise.
Set<String>	filterAllowedContentViewNames(Set<String> names) Provide a filter to remove un authorised content views name.
List<String>	getAllowedContentViewNames() Return a list of content views name that are associated with the local configuration
List<String>	getDeniedContentViewNames() Return a list of content views name that are denied with the local configuration
DocumentRef	getDocumentRef() Returns the related DocumentRef of this local configuration.
FacetedSearchConfiguration	merge(FacetedSearchConfiguration other) Merge this LocalConfiguration with another one.

Methods inherited from class org.nuxeo.ecm.core.api.localconfiguration.AbstractLocalConfiguration

save

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.nuxeo.ecm.core.api.localconfiguration.LocalConfiguration

save

Constructor Detail

FacetedSearchConfigurationAdapter

public FacetedSearchConfigurationAdapter(DocumentModel doc)

Method Detail

getDocumentRef

public DocumentRef getDocumentRef()

Description copied from interface: LocalConfiguration

Returns the related DocumentRef of this local configuration.

Specified by:

getDocumentRef in interface LocalConfiguration<FacetedSearchConfiguration>

canMerge

public boolean canMerge()

Description copied from interface: LocalConfiguration

Returns true if this LocalConfiguration accepted to be merged with a parent configuration, false otherwise.

Specified by:

canMerge in interface LocalConfiguration<FacetedSearchConfiguration>

Overrides:

canMerge in class AbstractLocalConfiguration<FacetedSearchConfiguration>

merge

public FacetedSearchConfiguration merge(FacetedSearchConfiguration other)

Description copied from interface: LocalConfiguration

Merge this LocalConfiguration with another one.

Specified by:

merge in interface LocalConfiguration<FacetedSearchConfiguration>

Overrides:

merge in class AbstractLocalConfiguration<FacetedSearchConfiguration>

getAllowedContentViewNames

public List<String> getAllowedContentViewNames()

Description copied from interface: FacetedSearchConfiguration

Return a list of content views name that are associated with the local configuration

Specified by:

getAllowedContentViewNames in interface FacetedSearchConfiguration

Returns:

an unmodifiable list of String or null.

getDeniedContentViewNames

public List<String> getDeniedContentViewNames()

Description copied from interface: FacetedSearchConfiguration

Return a list of content views name that are denied with the local configuration

Specified by:

getDeniedContentViewNames in interface FacetedSearchConfiguration

Returns:

an unmodifiable list of String or null.

filterAllowedContentViewNames

public Set<String> filterAllowedContentViewNames(Set<String> names)

Description copied from interface: FacetedSearchConfiguration

Provide a filter to remove un authorised content views name.

Specified by:

filterAllowedContentViewNames in interface FacetedSearchConfiguration

Parameters:

names - set of possible content views name

Returns:

a set without unauthorised content views, it should be empty.