com.evernote.edam.notestore
Class RelatedQuery

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

All Implemented Interfaces:

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

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

A description of the thing for which we are searching for related entities. You must specify either noteGuid or plainText, but not both. filter and referenceUri are optional.

noteGuid

The GUID of an existing note in your account for which related entities will be found.

plainText

A string of plain text for which to find related entities. You should provide a text block with a number of characters between EDAM_RELATED_PLAINTEXT_LEN_MIN and EDAM_RELATED_PLAINTEXT_LEN_MAX.

filter

The list of criteria that will constrain the notes being considered related. Please note that some of the parameters may be ignored, such as order and ascending.

referenceUri

A URI string specifying a reference entity, around which "relatedness" should be based. This can be an URL pointing to a web page, for example.

See Also:

Serialized Form

Constructor Summary

RelatedQuery()

RelatedQuery(RelatedQuery 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(RelatedQuery other)
RelatedQuery	deepCopy() Creates a deep copy of the object.
boolean	equals(java.lang.Object that)
boolean	equals(RelatedQuery that)
NoteFilter	getFilter()
java.lang.String	getNoteGuid()
java.lang.String	getPlainText()
java.lang.String	getReferenceUri()
int	hashCode()
boolean	isSetFilter() Returns true if field filter is set (has been asigned a value) and false otherwise
boolean	isSetNoteGuid() Returns true if field noteGuid is set (has been asigned a value) and false otherwise
boolean	isSetPlainText() Returns true if field plainText is set (has been asigned a value) and false otherwise
boolean	isSetReferenceUri() Returns true if field referenceUri 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	setFilter(NoteFilter filter)
void	setFilterIsSet(boolean value)
void	setNoteGuid(java.lang.String noteGuid)
void	setNoteGuidIsSet(boolean value)
void	setPlainText(java.lang.String plainText)
void	setPlainTextIsSet(boolean value)
void	setReferenceUri(java.lang.String referenceUri)
void	setReferenceUriIsSet(boolean value)
java.lang.String	toString()
void	unsetFilter()
void	unsetNoteGuid()
void	unsetPlainText()
void	unsetReferenceUri()
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

RelatedQuery

public RelatedQuery()

RelatedQuery

public RelatedQuery(RelatedQuery other)

Performs a deep copy on other.

Method Detail

deepCopy

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

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

getNoteGuid

public java.lang.String getNoteGuid()

setNoteGuid

public void setNoteGuid(java.lang.String noteGuid)

unsetNoteGuid

public void unsetNoteGuid()

isSetNoteGuid

public boolean isSetNoteGuid()

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

setNoteGuidIsSet

public void setNoteGuidIsSet(boolean value)

getPlainText

public java.lang.String getPlainText()

setPlainText

public void setPlainText(java.lang.String plainText)

unsetPlainText

public void unsetPlainText()

isSetPlainText

public boolean isSetPlainText()

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

setPlainTextIsSet

public void setPlainTextIsSet(boolean value)

getFilter

public NoteFilter getFilter()

setFilter

public void setFilter(NoteFilter filter)

unsetFilter

public void unsetFilter()

isSetFilter

public boolean isSetFilter()

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

setFilterIsSet

public void setFilterIsSet(boolean value)

getReferenceUri

public java.lang.String getReferenceUri()

setReferenceUri

public void setReferenceUri(java.lang.String referenceUri)

unsetReferenceUri

public void unsetReferenceUri()

isSetReferenceUri

public boolean isSetReferenceUri()

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

setReferenceUriIsSet

public void setReferenceUriIsSet(boolean value)

equals

public boolean equals(java.lang.Object that)

Overrides:

equals in class java.lang.Object

equals

public boolean equals(RelatedQuery that)

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

compareTo

public int compareTo(RelatedQuery other)

Specified by:

compareTo in interface java.lang.Comparable<RelatedQuery>

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

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

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