com.evernote.edam.notestore
Class RelatedResultSpec

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

All Implemented Interfaces:

com.evernote.thrift.TBase<RelatedResultSpec>, java.io.Serializable, java.lang.Cloneable, java.lang.Comparable<RelatedResultSpec>

public class RelatedResultSpec
extends java.lang.Object
implements com.evernote.thrift.TBase<RelatedResultSpec>, java.io.Serializable, java.lang.Cloneable

A description of the thing for which the service will find related entities, via findRelated(), together with a description of what type of entities and how many you are seeking in the RelatedResult.

maxNotes

Return notes that are related to the query, but no more than this many. Any value greater than EDAM_RELATED_MAX_NOTES will be silently capped. If you do not set this field, then no notes will be returned.

maxNotebooks

Return notebooks that are related to the query, but no more than this many. Any value greater than EDAM_RELATED_MAX_NOTEBOOKS will be silently capped. If you do not set this field, then no notebooks will be returned.

maxTags

Return tags that are related to the query, but no more than this many. Any value greater than EDAM_RELATED_MAX_TAGS will be silently capped. If you do not set this field, then no tags will be returned.

writableNotebooksOnly

Require that all returned related notebooks are writable. The user will be able to create notes in all returned notebooks. However, individual notes returned may still belong to notebooks in which the user lacks the ability to create notes.

includeContainingNotebooks

If set to true, return the containingNotebooks field in the RelatedResult, which will contain the list of notebooks to to which the returned related notes belong.

See Also:

Serialized Form

Constructor Summary

RelatedResultSpec()

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

Method Summary

void	clear() Return to the state of having just been initialized, as though you had just called the default constructor.
int	compareTo(RelatedResultSpec other)
RelatedResultSpec	deepCopy() Creates a deep copy of the object.
boolean	equals(java.lang.Object that)
boolean	equals(RelatedResultSpec that)
int	getMaxNotebooks()
int	getMaxNotes()
int	getMaxTags()
int	hashCode()
boolean	isIncludeContainingNotebooks()
boolean	isSetIncludeContainingNotebooks() Returns true if field includeContainingNotebooks is set (has been asigned a value) and false otherwise
boolean	isSetMaxNotebooks() Returns true if field maxNotebooks is set (has been asigned a value) and false otherwise
boolean	isSetMaxNotes() Returns true if field maxNotes is set (has been asigned a value) and false otherwise
boolean	isSetMaxTags() Returns true if field maxTags is set (has been asigned a value) and false otherwise
boolean	isSetWritableNotebooksOnly() Returns true if field writableNotebooksOnly is set (has been asigned a value) and false otherwise
boolean	isWritableNotebooksOnly()
void	read(com.evernote.thrift.protocol.TProtocol iprot) Reads an instance of the object from the given protocol.
void	setIncludeContainingNotebooks(boolean includeContainingNotebooks)
void	setIncludeContainingNotebooksIsSet(boolean value)
void	setMaxNotebooks(int maxNotebooks)
void	setMaxNotebooksIsSet(boolean value)
void	setMaxNotes(int maxNotes)
void	setMaxNotesIsSet(boolean value)
void	setMaxTags(int maxTags)
void	setMaxTagsIsSet(boolean value)
void	setWritableNotebooksOnly(boolean writableNotebooksOnly)
void	setWritableNotebooksOnlyIsSet(boolean value)
java.lang.String	toString()
void	unsetIncludeContainingNotebooks()
void	unsetMaxNotebooks()
void	unsetMaxNotes()
void	unsetMaxTags()
void	unsetWritableNotebooksOnly()
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

RelatedResultSpec

public RelatedResultSpec()

RelatedResultSpec

public RelatedResultSpec(RelatedResultSpec other)

Performs a deep copy on other.

Method Detail

deepCopy

public RelatedResultSpec 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<RelatedResultSpec>

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<RelatedResultSpec>

getMaxNotes

public int getMaxNotes()

setMaxNotes

public void setMaxNotes(int maxNotes)

unsetMaxNotes

public void unsetMaxNotes()

isSetMaxNotes

public boolean isSetMaxNotes()

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

setMaxNotesIsSet

public void setMaxNotesIsSet(boolean value)

getMaxNotebooks

public int getMaxNotebooks()

setMaxNotebooks

public void setMaxNotebooks(int maxNotebooks)

unsetMaxNotebooks

public void unsetMaxNotebooks()

isSetMaxNotebooks

public boolean isSetMaxNotebooks()

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

setMaxNotebooksIsSet

public void setMaxNotebooksIsSet(boolean value)

getMaxTags

public int getMaxTags()

setMaxTags

public void setMaxTags(int maxTags)

unsetMaxTags

public void unsetMaxTags()

isSetMaxTags

public boolean isSetMaxTags()

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

setMaxTagsIsSet

public void setMaxTagsIsSet(boolean value)

isWritableNotebooksOnly

public boolean isWritableNotebooksOnly()

setWritableNotebooksOnly

public void setWritableNotebooksOnly(boolean writableNotebooksOnly)

unsetWritableNotebooksOnly

public void unsetWritableNotebooksOnly()

isSetWritableNotebooksOnly

public boolean isSetWritableNotebooksOnly()

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

setWritableNotebooksOnlyIsSet

public void setWritableNotebooksOnlyIsSet(boolean value)

isIncludeContainingNotebooks

public boolean isIncludeContainingNotebooks()

setIncludeContainingNotebooks

public void setIncludeContainingNotebooks(boolean includeContainingNotebooks)

unsetIncludeContainingNotebooks

public void unsetIncludeContainingNotebooks()

isSetIncludeContainingNotebooks

public boolean isSetIncludeContainingNotebooks()

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

setIncludeContainingNotebooksIsSet

public void setIncludeContainingNotebooksIsSet(boolean value)

equals

public boolean equals(java.lang.Object that)

Overrides:

equals in class java.lang.Object

equals

public boolean equals(RelatedResultSpec that)

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

compareTo

public int compareTo(RelatedResultSpec other)

Specified by:

compareTo in interface java.lang.Comparable<RelatedResultSpec>

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<RelatedResultSpec>

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<RelatedResultSpec>

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