org.nuxeo.ecm.webapp.contentbrowser

Class DocumentSuggestionActions

java.lang.Object

org.nuxeo.ecm.webapp.contentbrowser.DocumentSuggestionActions

All Implemented Interfaces:

Serializable

@Name(value="docSuggestionActions")
 @Scope(value=PAGE)
public class DocumentSuggestionActions
extends Object
implements Serializable

Provides suggestion methods on documents

Since:

5.4.2

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected Object	cachedInput
protected String	cachedPageProviderName
protected List<DocumentModel>	cachedSuggestions
static String	DEFAULT_PAGE_PROVIDER_NAME
protected CoreSession	documentManager
protected String	pageProviderName
protected Boolean	prefixSearch If true, '*' will be appended to the pattern to do a prefix search.

Constructor Summary

Constructors

Constructor and Description
DocumentSuggestionActions()

Method Summary

Modifier and Type	Method and Description
protected boolean	equals(Object item1, Object item2)
List<DocumentModel>	getDocSuggestions(Object input)
boolean	getDocumentExistsAndIsVisibleWithId(String id)
boolean	getDocumentExistsAndIsVisibleWithPath(String path)
DocumentModel	getDocumentWithId(String id)
DocumentModel	getDocumentWithPath(String path)
protected PageProvider<DocumentModel>	getPageProvider(String pattern) Returns suggestion documents matching given pattern.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_PAGE_PROVIDER_NAME

public static final String DEFAULT_PAGE_PROVIDER_NAME

See Also:

Constant Field Values

documentManager

@In(required=true)
protected transient CoreSession documentManager

pageProviderName

@RequestParameter
protected String pageProviderName

prefixSearch

@RequestParameter
protected Boolean prefixSearch

If true, '*' will be appended to the pattern to do a prefix search.

Since:

5.7.2

cachedPageProviderName

protected String cachedPageProviderName

cachedInput

protected Object cachedInput

cachedSuggestions

protected List<DocumentModel> cachedSuggestions

Constructor Detail

DocumentSuggestionActions

public DocumentSuggestionActions()

Method Detail

getDocSuggestions

public List<DocumentModel> getDocSuggestions(Object input)

getPageProvider

protected PageProvider<DocumentModel> getPageProvider(String pattern)

Returns suggestion documents matching given pattern.

Search is performed using the page provider referenced in the widget definition (defaults to DEFAULT_PAGE_PROVIDER_NAME).

Since 5.7, if the page provider defines parameters, they're added to the implicit parameter (the pattern) that stays the first one to be referenced in the search query.

Parameters:

pattern: - the input as typed by user in suggestion box

getDocumentExistsAndIsVisibleWithId

public boolean getDocumentExistsAndIsVisibleWithId(String id)

getDocumentExistsAndIsVisibleWithPath

public boolean getDocumentExistsAndIsVisibleWithPath(String path)

getDocumentWithId

public DocumentModel getDocumentWithId(String id)

getDocumentWithPath

public DocumentModel getDocumentWithPath(String path)

equals

protected boolean equals(Object item1,
                         Object item2)