com.evernote.edam.notestore
Class RelatedResult

java.lang.Object
  com.evernote.edam.notestore.RelatedResult

All Implemented Interfaces:

TBase<RelatedResult>, Serializable, Cloneable, Comparable<RelatedResult>

public class RelatedResult
extends Object
implements TBase<RelatedResult>, Serializable, Cloneable

The result of calling findRelated(). The contents of the notes, notebooks, and tags fields will be in decreasing order of expected relevance. It is possible that fewer results than requested will be returned even if there are enough distinct entities in the account in cases where the relevance is estimated to be low.

notes

If notes have been requested to be included, this will be the list of notes.

notebooks

If notebooks have been requested to be included, this will be the list of notebooks.

tags

If tags have been requested to be included, this will be the list of tags.

containingNotebooks

If includeContainingNotebooks is set to true in the RelatedResultSpec, return the list of notebooks to to which the returned related notes belong. The notebooks in this list will occur once per notebook GUID and are represented as NotebookDescriptor objects.

See Also:

Serialized Form

Constructor Summary

RelatedResult()

RelatedResult(RelatedResult other)
Performs a deep copy on other.

Method Summary

void	addToContainingNotebooks(NotebookDescriptor elem)
void	addToNotebooks(Notebook elem)
void	addToNotes(Note elem)
void	addToTags(Tag elem)
void	clear() Return to the state of having just been initialized, as though you had just called the default constructor.
int	compareTo(RelatedResult other)
RelatedResult	deepCopy() Creates a deep copy of the object.
boolean	equals(Object that)
boolean	equals(RelatedResult that)
List<NotebookDescriptor>	getContainingNotebooks()
Iterator<NotebookDescriptor>	getContainingNotebooksIterator()
int	getContainingNotebooksSize()
List<Notebook>	getNotebooks()
Iterator<Notebook>	getNotebooksIterator()
int	getNotebooksSize()
List<Note>	getNotes()
Iterator<Note>	getNotesIterator()
int	getNotesSize()
List<Tag>	getTags()
Iterator<Tag>	getTagsIterator()
int	getTagsSize()
int	hashCode()
boolean	isSetContainingNotebooks() Returns true if field containingNotebooks is set (has been asigned a value) and false otherwise
boolean	isSetNotebooks() Returns true if field notebooks is set (has been asigned a value) and false otherwise
boolean	isSetNotes() Returns true if field notes is set (has been asigned a value) and false otherwise
boolean	isSetTags() Returns true if field tags is set (has been asigned a value) and false otherwise
void	read(TProtocol iprot) Reads an instance of the object from the given protocol.
void	setContainingNotebooks(List<NotebookDescriptor> containingNotebooks)
void	setContainingNotebooksIsSet(boolean value)
void	setNotebooks(List<Notebook> notebooks)
void	setNotebooksIsSet(boolean value)
void	setNotes(List<Note> notes)
void	setNotesIsSet(boolean value)
void	setTags(List<Tag> tags)
void	setTagsIsSet(boolean value)
String	toString()
void	unsetContainingNotebooks()
void	unsetNotebooks()
void	unsetNotes()
void	unsetTags()
void	validate()
void	write(TProtocol oprot) Writes the object to the given protocol.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

RelatedResult

public RelatedResult()

RelatedResult

public RelatedResult(RelatedResult other)

Performs a deep copy on other.

Method Detail

deepCopy

public RelatedResult deepCopy()

Description copied from interface: TBase

Creates a deep copy of the object.

Specified by:

deepCopy in interface TBase<RelatedResult>

clear

public void clear()

Description copied from interface: TBase

Return to the state of having just been initialized, as though you had just called the default constructor.

Specified by:

clear in interface TBase<RelatedResult>

getNotesSize

public int getNotesSize()

getNotesIterator

public Iterator<Note> getNotesIterator()

addToNotes

public void addToNotes(Note elem)

getNotes

public List<Note> getNotes()

setNotes

public void setNotes(List<Note> notes)

unsetNotes

public void unsetNotes()

isSetNotes

public boolean isSetNotes()

Returns true if field notes is set (has been asigned a value) and false otherwise

setNotesIsSet

public void setNotesIsSet(boolean value)

getNotebooksSize

public int getNotebooksSize()

getNotebooksIterator

public Iterator<Notebook> getNotebooksIterator()

addToNotebooks

public void addToNotebooks(Notebook elem)

getNotebooks

public List<Notebook> getNotebooks()

setNotebooks

public void setNotebooks(List<Notebook> notebooks)

unsetNotebooks

public void unsetNotebooks()

isSetNotebooks

public boolean isSetNotebooks()

Returns true if field notebooks is set (has been asigned a value) and false otherwise

setNotebooksIsSet

public void setNotebooksIsSet(boolean value)

getTagsSize

public int getTagsSize()

getTagsIterator

public Iterator<Tag> getTagsIterator()

addToTags

public void addToTags(Tag elem)

getTags

public List<Tag> getTags()

setTags

public void setTags(List<Tag> tags)

unsetTags

public void unsetTags()

isSetTags

public boolean isSetTags()

Returns true if field tags is set (has been asigned a value) and false otherwise

setTagsIsSet

public void setTagsIsSet(boolean value)

getContainingNotebooksSize

public int getContainingNotebooksSize()

getContainingNotebooksIterator

public Iterator<NotebookDescriptor> getContainingNotebooksIterator()

addToContainingNotebooks

public void addToContainingNotebooks(NotebookDescriptor elem)

getContainingNotebooks

public List<NotebookDescriptor> getContainingNotebooks()

setContainingNotebooks

public void setContainingNotebooks(List<NotebookDescriptor> containingNotebooks)

unsetContainingNotebooks

public void unsetContainingNotebooks()

isSetContainingNotebooks

public boolean isSetContainingNotebooks()

Returns true if field containingNotebooks is set (has been asigned a value) and false otherwise

setContainingNotebooksIsSet

public void setContainingNotebooksIsSet(boolean value)

equals

public boolean equals(Object that)

Overrides:

equals in class Object

equals

public boolean equals(RelatedResult that)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

compareTo

public int compareTo(RelatedResult other)

Specified by:

compareTo in interface Comparable<RelatedResult>

read

public void read(TProtocol iprot)
          throws TException

Description copied from interface: TBase

Reads an instance of the object from the given protocol.

Specified by:

read in interface TBase<RelatedResult>

Parameters:

iprot - Input protocol

Throws:

TException

write

public void write(TProtocol oprot)
           throws TException

Description copied from interface: TBase

Writes the object to the given protocol.

Specified by:

write in interface TBase<RelatedResult>

Parameters:

oprot - Output protocol

Throws:

TException

toString

public String toString()

Overrides:

toString in class Object

validate

public void validate()
              throws TException

Throws:

TException