org.alfresco.mobile.android.api.model

Class KeywordSearchOptions

java.lang.Object

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

All Implemented Interfaces:

Serializable

public class KeywordSearchOptions
extends Object
implements Serializable

Search Parameters provides informations to manage the behaviour of a search. It define how a query search available at SearchService.

Author:

Jean Marie Pascal

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	TYPENAME_DOCUMENT
static String	TYPENAME_FOLDER

Constructor Summary

Constructors

Constructor and Description
KeywordSearchOptions() Instantiates a new keyword search options.
KeywordSearchOptions(Folder folder, boolean doesIncludeDescendants, boolean doesIncludeContent, boolean isExactMatch) Base constructor for a KeywordSearchOptions.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	doesIncludeContent() Determines whether the keyword search should search in the content as well as the name, title and description properties.
boolean	doesIncludeDescendants() Determines whether the search should also search in child folders, only applies if the search is restricted to a specific folder.
Folder	getFolder() Returns the folder the search should be restricted to, if null is returned the whole repository is searched.
String	getTypeName() Returns the type name to use in the keyword search, “cmis:document” by default.
boolean	isExactMatch() Determines whether the keyword search should only search for exact matches.
void	setDoesIncludeContent(boolean doesIncludeContent) Specifies whether the search should include child folders.
void	setExactMatch(boolean exactMatch) Sets the exact match.
void	setFolder(Folder inFolder) Sets the folder.
void	setIncludeDescendants(boolean includeDescendents) Specifies whether the search should include child folders.
void	setTypeName(String typeName) Sets the type name to be used in the keyword search.

Methods inherited from class java.lang.Object

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

Field Detail

TYPENAME_DOCUMENT

public static final String TYPENAME_DOCUMENT

See Also:

Constant Field Values

TYPENAME_FOLDER

public static final String TYPENAME_FOLDER

See Also:

Constant Field Values

Constructor Detail

KeywordSearchOptions

public KeywordSearchOptions()

Instantiates a new keyword search options.

KeywordSearchOptions

public KeywordSearchOptions(Folder folder,
                    boolean doesIncludeDescendants,
                    boolean doesIncludeContent,
                    boolean isExactMatch)

Base constructor for a KeywordSearchOptions.

Parameters:

folder - : Relative folder from where a search start. Default is null.

doesIncludeDescendants - : Default is true.

doesIncludeContent - : Default is true.

isExactMatch - : Default is false.

Method Detail

getFolder

public Folder getFolder()

Returns the folder the search should be restricted to, if null is returned the whole repository is searched. Default is null.

Returns:

the relative folder

setFolder

public void setFolder(Folder inFolder)

Sets the folder.

Parameters:

inFolder - Sets the folder the the search should be restricted to.

doesIncludeDescendants

public boolean doesIncludeDescendants()

Determines whether the search should also search in child folders, only applies if the search is restricted to a specific folder. Default is true.

Returns:

true, if the search must be restrict on all descendants of a specific folder.

setIncludeDescendants

public void setIncludeDescendants(boolean includeDescendents)

Specifies whether the search should include child folders.

Parameters:

includeDescendents - the includeDescendents to set

isExactMatch

public boolean isExactMatch()

Determines whether the keyword search should only search for exact matches. Default is false.

Returns:

true, if the search must be restrict on exact keywords matches.

setExactMatch

public void setExactMatch(boolean exactMatch)

Sets the exact match.

Parameters:

exactMatch - the new exact match

doesIncludeContent

public boolean doesIncludeContent()

Determines whether the keyword search should search in the content as well as the name, title and description properties. Default is true.

Returns:

true, if the search must search into content.

setDoesIncludeContent

public void setDoesIncludeContent(boolean doesIncludeContent)

Specifies whether the search should include child folders.

Parameters:

doesIncludeContent - the new does include content

getTypeName

public String getTypeName()

Returns the type name to use in the keyword search, “cmis:document” by default.

Returns:

Since:

1.4

setTypeName

public void setTypeName(String typeName)

Sets the type name to be used in the keyword search.

Since:

1.4