com.evernote.client.android.asyncclient

Class EvernoteSearchHelper.Search

java.lang.Object

com.evernote.client.android.asyncclient.EvernoteSearchHelper.Search

Enclosing class:

EvernoteSearchHelper

public static class EvernoteSearchHelper.Search
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
Search()

Method Summary

Modifier and Type	Method and Description
EvernoteSearchHelper.Search	addLinkedNotebook(LinkedNotebook linkedNotebook) Specify in which notebooks notes are queried.
EvernoteSearchHelper.Search	addScope(EvernoteSearchHelper.Scope scope) If no scope is specified, EvernoteSearchHelper.Scope.PERSONAL_NOTES is the default value.
boolean	isIgnoreExceptions()
EvernoteSearchHelper.Search	setIgnoreExceptions(boolean ignoreExceptions) The default value is false.
EvernoteSearchHelper.Search	setMaxNotes(int maxNotes) The default value is 10.
EvernoteSearchHelper.Search	setNoteFilter(NoteFilter noteFilter) If not filter is set, then the default value only sets NoteSortOrder#UPDATED.
EvernoteSearchHelper.Search	setOffset(int offset) The default value is 0.
EvernoteSearchHelper.Search	setPageSize(int pageSize) The default value is 10.
EvernoteSearchHelper.Search	setResultSpec(NotesMetadataResultSpec resultSpec) If no spec is set, then the default value will include the note's title and notebook GUID.

Methods inherited from class java.lang.Object

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

Constructor Detail

Search

public Search()

Method Detail

addScope

public EvernoteSearchHelper.Search addScope(EvernoteSearchHelper.Scope scope)

If no scope is specified, EvernoteSearchHelper.Scope.PERSONAL_NOTES is the default value.

Attention: If you add EvernoteSearchHelper.Scope.LINKED_NOTEBOOKS or EvernoteSearchHelper.Scope.BUSINESS and don't add a specific LinkedNotebook, then this search may be very intense.

Parameters:

scope - Add this scope to the search.

See Also:

addLinkedNotebook(LinkedNotebook)

addLinkedNotebook

public EvernoteSearchHelper.Search addLinkedNotebook(LinkedNotebook linkedNotebook)

Specify in which notebooks notes are queried. If this linked notebook is a business notebook, EvernoteSearchHelper.Scope.BUSINESS is automatically added, otherwise EvernoteSearchHelper.Scope.LINKED_NOTEBOOKS is added.

By default no specific linked notebook is defined.

Parameters:

linkedNotebook - The desired linked notebook.

See Also:

#addScope(Scope)

setNoteFilter

public EvernoteSearchHelper.Search setNoteFilter(NoteFilter noteFilter)

If not filter is set, then the default value only sets NoteSortOrder#UPDATED.

Parameters:

noteFilter - The used filter for all queries.

setResultSpec

public EvernoteSearchHelper.Search setResultSpec(NotesMetadataResultSpec resultSpec)

If no spec is set, then the default value will include the note's title and notebook GUID.

Parameters:

resultSpec - The used result spec for all queries.

setOffset

public EvernoteSearchHelper.Search setOffset(int offset)

The default value is 0.

Parameters:

offset - The beginning offset for all queries.

setMaxNotes

public EvernoteSearchHelper.Search setMaxNotes(int maxNotes)

The default value is 10. Set this value to Integer.MAX_VALUE, if you want to query all notes. The higher this value the more intense is the whole search.

Parameters:

maxNotes - The maximum note count for all queries.

setPageSize

public EvernoteSearchHelper.Search setPageSize(int pageSize)

The default value is 10.

Parameters:

pageSize - The page size for a single search.

setIgnoreExceptions

public EvernoteSearchHelper.Search setIgnoreExceptions(boolean ignoreExceptions)

The default value is false.

Parameters:

ignoreExceptions - If true then most exceptions while running the search are caught and ignored.

isIgnoreExceptions

public boolean isIgnoreExceptions()