com.evernote.client.android.asyncclient

Class EvernoteSearchHelper

java.lang.Object

com.evernote.client.android.asyncclient.EvernoteAsyncClient

com.evernote.client.android.asyncclient.EvernoteSearchHelper

public class EvernoteSearchHelper
extends EvernoteAsyncClient

Provides an unified search method to look for notes in multiple note stores.

Be careful using this class. A query may be very intense and could require multiple requests.

The easiest way to create an instance is to call EvernoteClientFactory.getEvernoteSearchHelper().

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	EvernoteSearchHelper.Result A search result.
static class	EvernoteSearchHelper.Scope Defines from where the notes are queried.
static class	EvernoteSearchHelper.Search

Constructor Summary

Constructors

Constructor and Description
EvernoteSearchHelper(EvernoteSession session, java.util.concurrent.ExecutorService executorService)

Method Summary

Modifier and Type	Method and Description
EvernoteSearchHelper.Result	execute(EvernoteSearchHelper.Search search) Submits a search.
java.util.concurrent.Future<EvernoteSearchHelper.Result>	executeAsync(EvernoteSearchHelper.Search search, EvernoteCallback<EvernoteSearchHelper.Result> callback)
protected java.util.List<NotesMetadataList>	findAllNotes(EvernoteSearchHelper.Search search, EvernoteNoteStoreClient client, NoteFilter filter)
protected java.util.List<NotesMetadataList>	findNotesInBusinessNotebook(EvernoteSearchHelper.Search search, LinkedNotebook linkedNotebook)
protected java.util.List<NotesMetadataList>	findNotesInLinkedNotebook(EvernoteSearchHelper.Search search, LinkedNotebook linkedNotebook)
protected java.util.List<NotesMetadataList>	findPersonalNotes(EvernoteSearchHelper.Search search)
protected java.util.List<LinkedNotebook>	getLinkedNotebooks(EvernoteSearchHelper.Search search, boolean business)

Methods inherited from class com.evernote.client.android.asyncclient.EvernoteAsyncClient

runOnUiThread, submitTask

Methods inherited from class java.lang.Object

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

Constructor Detail

EvernoteSearchHelper

public EvernoteSearchHelper(EvernoteSession session,
                            java.util.concurrent.ExecutorService executorService)

Parameters:

session - The current valid session.

executorService - The executor running the actions in the background.

Method Detail

execute

public EvernoteSearchHelper.Result execute(EvernoteSearchHelper.Search search)
                                    throws java.lang.Exception

Submits a search.

Parameters:

search - The desired search with its parameters.

Returns:

The result containing multiple NotesMetadataLists.

Throws:

java.lang.Exception

executeAsync

public java.util.concurrent.Future<EvernoteSearchHelper.Result> executeAsync(EvernoteSearchHelper.Search search,
                                                                             EvernoteCallback<EvernoteSearchHelper.Result> callback)

See Also:

execute(Search)

findPersonalNotes

protected java.util.List<NotesMetadataList> findPersonalNotes(EvernoteSearchHelper.Search search)
                                                       throws java.lang.Exception

Throws:

java.lang.Exception

findNotesInLinkedNotebook

protected java.util.List<NotesMetadataList> findNotesInLinkedNotebook(EvernoteSearchHelper.Search search,
                                                                      LinkedNotebook linkedNotebook)
                                                               throws java.lang.Exception

Throws:

java.lang.Exception

findNotesInBusinessNotebook

protected java.util.List<NotesMetadataList> findNotesInBusinessNotebook(EvernoteSearchHelper.Search search,
                                                                        LinkedNotebook linkedNotebook)
                                                                 throws java.lang.Exception

Throws:

java.lang.Exception

findAllNotes

protected java.util.List<NotesMetadataList> findAllNotes(EvernoteSearchHelper.Search search,
                                                         EvernoteNoteStoreClient client,
                                                         NoteFilter filter)
                                                  throws java.lang.Exception

Throws:

java.lang.Exception

getLinkedNotebooks

protected java.util.List<LinkedNotebook> getLinkedNotebooks(EvernoteSearchHelper.Search search,
                                                            boolean business)
                                                     throws java.lang.Exception

Throws:

java.lang.Exception