org.alfresco.mobile.android.api.services

Interface SearchService

All Superinterfaces:

android.os.Parcelable, Service

All Known Implementing Classes:

SearchServiceImpl

public interface SearchService
extends Service

The Search service provides methods for querying the repository and returning a filtered collection of nodes based on a user’s permission

Author:

Jean Marie Pascal

Nested Class Summary

Nested classes/interfaces inherited from interface android.os.Parcelable

android.os.Parcelable.ClassLoaderCreator<T>, android.os.Parcelable.Creator<T>

Field Summary

Fields

Modifier and Type	Field and Description
static String	SORT_PROPERTY_CREATED_AT Allowable sorting property : Creation Date
static String	SORT_PROPERTY_DESCRIPTION Allowable sorting property : Description
static String	SORT_PROPERTY_MODIFIED_AT Allowable sorting property : Modification Date
static String	SORT_PROPERTY_NAME Allowable sorting property : Name of the document or folder.
static String	SORT_PROPERTY_TITLE Allowable sorting property : Title of the document or folder.

Fields inherited from interface android.os.Parcelable

CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE

Method Summary

Methods

Modifier and Type	Method and Description
List<Node>	keywordSearch(String keywords, KeywordSearchOptions options) A space delimited list of keywords to search for.
PagingResult<Node>	keywordSearch(String keywords, KeywordSearchOptions options, ListingContext listingContext) A space delimited list of keywords to search for.
List<Node>	search(String statement, SearchLanguage language) Executes a query statement against the contents of the repository using the given search language.
PagingResult<Node>	search(String statement, SearchLanguage language, ListingContext listingContext) Executes a query statement against the contents of the repository using the given search language.

Methods inherited from interface org.alfresco.mobile.android.api.services.Service

clear

Methods inherited from interface android.os.Parcelable

describeContents, writeToParcel

Field Detail

SORT_PROPERTY_NAME

static final String SORT_PROPERTY_NAME

Allowable sorting property : Name of the document or folder.

SORT_PROPERTY_TITLE

static final String SORT_PROPERTY_TITLE

Allowable sorting property : Title of the document or folder.

SORT_PROPERTY_DESCRIPTION

static final String SORT_PROPERTY_DESCRIPTION

Allowable sorting property : Description

SORT_PROPERTY_CREATED_AT

static final String SORT_PROPERTY_CREATED_AT

Allowable sorting property : Creation Date

SORT_PROPERTY_MODIFIED_AT

static final String SORT_PROPERTY_MODIFIED_AT

Allowable sorting property : Modification Date

Method Detail

search

PagingResult<Node> search(String statement,
                        SearchLanguage language,
                        ListingContext listingContext)

Executes a query statement against the contents of the repository using the given search language.

Parameters:

statement - : query statement associated to the search language.

language - : Defined by SearchLanguage

listingContext: - Listing context that define the behaviour of paging results ListingContext

Returns:

Returns a list of nodes that match the statement.

Throws:

AlfrescoServiceException - : if network or internal problems occur during the process.

search

List<Node> search(String statement,
                SearchLanguage language)

Executes a query statement against the contents of the repository using the given search language.

Parameters:

statement - : query statement associated to the search language.

language - : Defined by SearchLanguage

Returns:

Returns a paged list of nodes that match the statement.

Throws:

AlfrescoServiceException - : if network or internal problems occur during the process.

keywordSearch

PagingResult<Node> keywordSearch(String keywords,
                               KeywordSearchOptions options,
                               ListingContext listingContext)

A space delimited list of keywords to search for. The options object defines the behaviour of the search i.e. whether to scope to the search to a folder.

Parameters:

keywords - : A space delimited list of keywords to search for

options - : defines the search scope.

listingContext - : Listing context that define the behaviour of paging results ListingContext

Returns:

Returns a paged list of nodes that match keywords.

Throws:

AlfrescoServiceException - : if network or internal problems occur during the process.

keywordSearch

List<Node> keywordSearch(String keywords,
                       KeywordSearchOptions options)

A space delimited list of keywords to search for. The options object defines the behaviour of the search i.e. whether to scope to the search to a folder.

Parameters:

keywords - : A space delimited list of keywords to search for

options - : defines the search scope.

Returns:

Returns a list of nodes that match keywords.

Throws:

AlfrescoServiceException - : if network or internal problems occur during the process.