com.evernote.edam.notestore
Class RelatedResult

java.lang.Object
  extended by com.evernote.edam.notestore.RelatedResult
All Implemented Interfaces:
com.evernote.thrift.TBase<RelatedResult>, java.io.Serializable, java.lang.Cloneable, java.lang.Comparable<RelatedResult>

public class RelatedResult
extends java.lang.Object
implements com.evernote.thrift.TBase<RelatedResult>, java.io.Serializable, java.lang.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(java.lang.Object that)
           
 boolean equals(RelatedResult that)
           
 java.util.List<NotebookDescriptor> getContainingNotebooks()
           
 java.util.Iterator<NotebookDescriptor> getContainingNotebooksIterator()
           
 int getContainingNotebooksSize()
           
 java.util.List<Notebook> getNotebooks()
           
 java.util.Iterator<Notebook> getNotebooksIterator()
           
 int getNotebooksSize()
           
 java.util.List<Note> getNotes()
           
 java.util.Iterator<Note> getNotesIterator()
           
 int getNotesSize()
           
 java.util.List<Tag> getTags()
           
 java.util.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(com.evernote.thrift.protocol.TProtocol iprot)
          Reads an instance of the object from the given protocol.
 void setContainingNotebooks(java.util.List<NotebookDescriptor> containingNotebooks)
           
 void setContainingNotebooksIsSet(boolean value)
           
 void setNotebooks(java.util.List<Notebook> notebooks)
           
 void setNotebooksIsSet(boolean value)
           
 void setNotes(java.util.List<Note> notes)
           
 void setNotesIsSet(boolean value)
           
 void setTags(java.util.List<Tag> tags)
           
 void setTagsIsSet(boolean value)
           
 java.lang.String toString()
           
 void unsetContainingNotebooks()
           
 void unsetNotebooks()
           
 void unsetNotes()
           
 void unsetTags()
           
 void validate()
           
 void write(com.evernote.thrift.protocol.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: com.evernote.thrift.TBase
Creates a deep copy of the object.

Specified by:
deepCopy in interface com.evernote.thrift.TBase<RelatedResult>

clear

public void clear()
Description copied from interface: com.evernote.thrift.TBase
Return to the state of having just been initialized, as though you had just called the default constructor.

Specified by:
clear in interface com.evernote.thrift.TBase<RelatedResult>

getNotesSize

public int getNotesSize()

getNotesIterator

public java.util.Iterator<Note> getNotesIterator()

addToNotes

public void addToNotes(Note elem)

getNotes

public java.util.List<Note> getNotes()

setNotes

public void setNotes(java.util.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 java.util.Iterator<Notebook> getNotebooksIterator()

addToNotebooks

public void addToNotebooks(Notebook elem)

getNotebooks

public java.util.List<Notebook> getNotebooks()

setNotebooks

public void setNotebooks(java.util.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 java.util.Iterator<Tag> getTagsIterator()

addToTags

public void addToTags(Tag elem)

getTags

public java.util.List<Tag> getTags()

setTags

public void setTags(java.util.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 java.util.Iterator<NotebookDescriptor> getContainingNotebooksIterator()

addToContainingNotebooks

public void addToContainingNotebooks(NotebookDescriptor elem)

getContainingNotebooks

public java.util.List<NotebookDescriptor> getContainingNotebooks()

setContainingNotebooks

public void setContainingNotebooks(java.util.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(java.lang.Object that)
Overrides:
equals in class java.lang.Object

equals

public boolean equals(RelatedResult that)

hashCode

public int hashCode()
Overrides:
hashCode in class java.lang.Object

compareTo

public int compareTo(RelatedResult other)
Specified by:
compareTo in interface java.lang.Comparable<RelatedResult>

read

public void read(com.evernote.thrift.protocol.TProtocol iprot)
          throws com.evernote.thrift.TException
Description copied from interface: com.evernote.thrift.TBase
Reads an instance of the object from the given protocol.

Specified by:
read in interface com.evernote.thrift.TBase<RelatedResult>
Parameters:
iprot - Input protocol
Throws:
com.evernote.thrift.TException

write

public void write(com.evernote.thrift.protocol.TProtocol oprot)
           throws com.evernote.thrift.TException
Description copied from interface: com.evernote.thrift.TBase
Writes the object to the given protocol.

Specified by:
write in interface com.evernote.thrift.TBase<RelatedResult>
Parameters:
oprot - Output protocol
Throws:
com.evernote.thrift.TException

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object

validate

public void validate()
              throws com.evernote.thrift.TException
Throws:
com.evernote.thrift.TException