org.nuxeo.search.ui.localconfiguration

Class SearchConfigurationAdapter

java.lang.Object

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

org.nuxeo.search.ui.localconfiguration.SearchConfigurationAdapter

All Implemented Interfaces:

DetachedAdapter, LocalConfiguration<SearchConfiguration>, SearchConfiguration

public class SearchConfigurationAdapter
extends AbstractLocalConfiguration<SearchConfiguration>
implements SearchConfiguration

Default implementation of SearchConfiguration

Since:

6.0

Constructor Summary

Constructors

Constructor and Description
SearchConfigurationAdapter(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.
List<String>	filterAllowedContentViewNames(List<String> names) Provide a filter to remove unauthorized content views name.
List<String>	getAllowedContentViewNames() Return a list of content views name that are denied with the local configuration
DocumentRef	getDocumentRef() Returns the related DocumentRef of this local configuration.
SearchConfiguration	merge(SearchConfiguration 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

SearchConfigurationAdapter

public SearchConfigurationAdapter(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<SearchConfiguration>

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<SearchConfiguration>

Overrides:

canMerge in class AbstractLocalConfiguration<SearchConfiguration>

merge

public SearchConfiguration merge(SearchConfiguration other)

Description copied from interface: LocalConfiguration

Merge this LocalConfiguration with another one.

Specified by:

merge in interface LocalConfiguration<SearchConfiguration>

Overrides:

merge in class AbstractLocalConfiguration<SearchConfiguration>

getAllowedContentViewNames

public List<String> getAllowedContentViewNames()

Description copied from interface: SearchConfiguration

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

Specified by:

getAllowedContentViewNames in interface SearchConfiguration

Returns:

an unmodifiable list of String or null.

filterAllowedContentViewNames

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

Description copied from interface: SearchConfiguration

Provide a filter to remove unauthorized content views name.

Specified by:

filterAllowedContentViewNames in interface SearchConfiguration

Parameters:

names - set of possible content views name

Returns:

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