com.evernote.client.android.type

Class NoteRef

java.lang.Object

com.evernote.client.android.type.NoteRef

All Implemented Interfaces:

android.os.Parcelable

public class NoteRef
extends java.lang.Object
implements android.os.Parcelable

A reference to a note on the server. This class provides several helper methods to receive the note itself, its notebook and content.

Use the NoteRef.DefaultFactory class to instantiate objects. The easiest way to get a reference is to use the EvernoteSearchHelper to find notes.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	NoteRef.DefaultFactory The default factory to create NoteRef instances.
static interface	NoteRef.Factory A factory to construct NoteRef instances.

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 android.os.Parcelable.Creator<NoteRef>	CREATOR

Fields inherited from interface android.os.Parcelable

CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE

Constructor Summary

Constructors

Constructor and Description
NoteRef(java.lang.String noteGuid, java.lang.String notebookGuid, java.lang.String title, boolean linked)

Method Summary

Modifier and Type	Method and Description
int	describeContents()
java.lang.String	getGuid()
java.lang.String	getNotebookGuid()
java.lang.String	getTitle()
boolean	isLinked()
LinkedNotebook	loadLinkedNotebook()
Note	loadNote(boolean withContent, boolean withResourcesData, boolean withResourcesRecognition, boolean withResourcesAlternateData) Loads the concrete note from the server.
Notebook	loadNotebook() If this note is linked, then it loads the corresponding notebook for the linked notebook.
Note	loadNoteFully()
Note	loadNotePartial()
void	writeToParcel(android.os.Parcel dest, int flags)

Methods inherited from class java.lang.Object

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

Field Detail

CREATOR

public static final android.os.Parcelable.Creator<NoteRef> CREATOR

Constructor Detail

NoteRef

public NoteRef(java.lang.String noteGuid,
               java.lang.String notebookGuid,
               java.lang.String title,
               boolean linked)

Method Detail

getGuid

public java.lang.String getGuid()

Returns:

The note's GUID. This value is never null.

getNotebookGuid

public java.lang.String getNotebookGuid()

Returns:

The note's notebook GUID. This GUID is either from a personal or linked notebook. May return null, e.g. if the NotesMetadataResultSpec did not include the notebook GUID. It's recommend to include the notebook GUID always.

See Also:

isLinked()

getTitle

public java.lang.String getTitle()

Returns:

The note's title. This value is never null.

isLinked

public boolean isLinked()

Returns:

true if this note exists in linked notebook.

loadNote

public Note loadNote(boolean withContent,
                     boolean withResourcesData,
                     boolean withResourcesRecognition,
                     boolean withResourcesAlternateData)
              throws TException,
                     EDAMUserException,
                     EDAMSystemException,
                     EDAMNotFoundException

Loads the concrete note from the server.

Parameters:

withContent - If true the returned note contains its content.

withResourcesData - If true the returned note contains its resources.

withResourcesRecognition - If true the returned note contains in its resources the recognition data.

withResourcesAlternateData - If true the returned note contains in its resources the alternate data.

Returns:

The note from the server.

Throws:

TException

EDAMUserException

EDAMSystemException

EDAMNotFoundException

loadNotePartial

public Note loadNotePartial()
                     throws EDAMUserException,
                            TException,
                            EDAMSystemException,
                            EDAMNotFoundException

Returns:

The note from the server without its content or resources.

Throws:

EDAMUserException

TException

EDAMSystemException

EDAMNotFoundException

See Also:

loadNote(boolean, boolean, boolean, boolean)

loadNoteFully

public Note loadNoteFully()
                   throws EDAMUserException,
                          TException,
                          EDAMSystemException,
                          EDAMNotFoundException

Returns:

The note from the server with its content, resources, recognition data and alternate data.

Throws:

EDAMUserException

TException

EDAMSystemException

EDAMNotFoundException

See Also:

loadNote(boolean, boolean, boolean, boolean)

loadNotebook

public Notebook loadNotebook()
                      throws EDAMUserException,
                             EDAMSystemException,
                             TException,
                             EDAMNotFoundException

If this note is linked, then it loads the corresponding notebook for the linked notebook. Use loadLinkedNotebook() to get the linked notebook.

Returns:

The note's notebook from server.

Throws:

EDAMUserException

EDAMSystemException

TException

EDAMNotFoundException

See Also:

isLinked(), EvernoteLinkedNotebookHelper.getCorrespondingNotebook()

loadLinkedNotebook

public LinkedNotebook loadLinkedNotebook()
                                  throws EDAMUserException,
                                         EDAMSystemException,
                                         TException,
                                         EDAMNotFoundException

Returns:

The linked notebook if this is a linked note.

Throws:

EDAMUserException

EDAMSystemException

TException

EDAMNotFoundException

See Also:

isLinked()

describeContents

public int describeContents()

Specified by:

describeContents in interface android.os.Parcelable

writeToParcel

public void writeToParcel(android.os.Parcel dest,
                          int flags)

Specified by:

writeToParcel in interface android.os.Parcelable