KeywordSearchOptions

org.alfresco.mobile.android.api.model.KeywordSearchOptions

This section describes the KeywordSearchOptions class.

Provides information to manage the behavior of a search. It defines how a query is made available to the Search Service.

Class declaration

public class KeywordSearchOptions implements Serializable

Inherits from	Implements
None	`Serializable`

Constructor - KeywordSearchOptionsKeywordSearchOptions constructs a KeywordSearchOptions object.
doesIncludeContentpublic boolean doesIncludeContent() Determines whether the keyword search should include the content as well as the name, title and description properties in its search. Default is true.
doesIncludeDescendentspublic boolean doesIncludeDescendents() Returns the value of the includeDescendents property. This property determines whether the search should also search in child folders. Only applies if the search is restricted to a specific folder. Default is true.
getFolderpublic Folder getFolder() Returns the folder the search should be restricted to, if null is returned the whole repository is searched. Default is null.
isExactMatchpublic boolean isExactMatch() Determines whether the keyword search should only search for exact matches. Default is false.
setDoesIncludeContentpublic void setDoesIncludeContent(String fullText) sets the doesIncludeContent property that controls full text searching. When set to true the content will be searched for the query string, along with the name, title and description.
setExactMatchpublic void setExactMatch(boolean exactMatch) sets the value of the property exactMatch. This property determines whether or not an exact match should be searched for, rather than a partial match.
setFolderpublic void setFolder(Folder inFolder) - sets the folder that the search should be restricted to.
setIncludeDescendentspublic boolean setIncludeDescendents() returns the status of the includeDescendents property. This property determines whether children should be included in the search. This only applies to searches where the search has been restricted to a specified folder.
getTypeNamepublic String getTypeName() - returns the type name to use in the keyword search, cmis:document is used by default.
setTypeNamepublic void setTypeName() - sets the type to be used in the keyword search.

Parent topic: org.alfresco.mobile.android.api.model

Search form

Search form

You are here

Class declaration