com.evernote.edam.notestore
Class NoteFilter

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

All Implemented Interfaces:

TBase<NoteFilter>, Serializable, Cloneable, Comparable<NoteFilter>

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

A list of criteria that are used to indicate which notes are desired from the account. This is used in queries to the NoteStore to determine which notes should be retrieved.

order

The NoteSortOrder value indicating what criterion should be used to sort the results of the filter.

ascending

If true, the results will be ascending in the requested sort order. If false, the results will be descending.

words

If present, a search query string that will filter the set of notes to be returned. Accepts the full search grammar documented in the Evernote API Overview.

notebookGuid

If present, the Guid of the notebook that must contain the notes.

tagGuids

If present, the list of tags (by GUID) that must be present on the notes.

timeZone

The zone ID for the user, which will be used to interpret any dates or times in the queries that do not include their desired zone information. For example, if a query requests notes created "yesterday", this will be evaluated from the provided time zone, if provided. The format must be encoded as a standard zone ID such as "America/Los_Angeles".

inactive

If true, then only notes that are not active (i.e. notes in the Trash) will be returned. Otherwise, only active notes will be returned. There is no way to find both active and inactive notes in a single query.

emphasized

If present, a search query string that may or may not influence the notes to be returned, both in terms of coverage as well as of order. Think of it as a wish list, not a requirement. Accepts the full search grammar documented in the Evernote API Overview.

See Also:

Serialized Form

Constructor Summary

NoteFilter()

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

Method Summary

void	addToTagGuids(String elem)
void	clear() Return to the state of having just been initialized, as though you had just called the default constructor.
int	compareTo(NoteFilter other)
NoteFilter	deepCopy() Creates a deep copy of the object.
boolean	equals(NoteFilter that)
boolean	equals(Object that)
String	getEmphasized()
String	getNotebookGuid()
int	getOrder()
List<String>	getTagGuids()
Iterator<String>	getTagGuidsIterator()
int	getTagGuidsSize()
String	getTimeZone()
String	getWords()
int	hashCode()
boolean	isAscending()
boolean	isInactive()
boolean	isSetAscending() Returns true if field ascending is set (has been asigned a value) and false otherwise
boolean	isSetEmphasized() Returns true if field emphasized is set (has been asigned a value) and false otherwise
boolean	isSetInactive() Returns true if field inactive is set (has been asigned a value) and false otherwise
boolean	isSetNotebookGuid() Returns true if field notebookGuid is set (has been asigned a value) and false otherwise
boolean	isSetOrder() Returns true if field order is set (has been asigned a value) and false otherwise
boolean	isSetTagGuids() Returns true if field tagGuids is set (has been asigned a value) and false otherwise
boolean	isSetTimeZone() Returns true if field timeZone is set (has been asigned a value) and false otherwise
boolean	isSetWords() Returns true if field words 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	setAscending(boolean ascending)
void	setAscendingIsSet(boolean value)
void	setEmphasized(String emphasized)
void	setEmphasizedIsSet(boolean value)
void	setInactive(boolean inactive)
void	setInactiveIsSet(boolean value)
void	setNotebookGuid(String notebookGuid)
void	setNotebookGuidIsSet(boolean value)
void	setOrder(int order)
void	setOrderIsSet(boolean value)
void	setTagGuids(List<String> tagGuids)
void	setTagGuidsIsSet(boolean value)
void	setTimeZone(String timeZone)
void	setTimeZoneIsSet(boolean value)
void	setWords(String words)
void	setWordsIsSet(boolean value)
String	toString()
void	unsetAscending()
void	unsetEmphasized()
void	unsetInactive()
void	unsetNotebookGuid()
void	unsetOrder()
void	unsetTagGuids()
void	unsetTimeZone()
void	unsetWords()
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

NoteFilter

public NoteFilter()

NoteFilter

public NoteFilter(NoteFilter other)

Performs a deep copy on other.

Method Detail

deepCopy

public NoteFilter deepCopy()

Description copied from interface: TBase

Creates a deep copy of the object.

Specified by:

deepCopy in interface TBase<NoteFilter>

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

getOrder

public int getOrder()

setOrder

public void setOrder(int order)

unsetOrder

public void unsetOrder()

isSetOrder

public boolean isSetOrder()

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

setOrderIsSet

public void setOrderIsSet(boolean value)

isAscending

public boolean isAscending()

setAscending

public void setAscending(boolean ascending)

unsetAscending

public void unsetAscending()

isSetAscending

public boolean isSetAscending()

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

setAscendingIsSet

public void setAscendingIsSet(boolean value)

getWords

public String getWords()

setWords

public void setWords(String words)

unsetWords

public void unsetWords()

isSetWords

public boolean isSetWords()

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

setWordsIsSet

public void setWordsIsSet(boolean value)

getNotebookGuid

public String getNotebookGuid()

setNotebookGuid

public void setNotebookGuid(String notebookGuid)

unsetNotebookGuid

public void unsetNotebookGuid()

isSetNotebookGuid

public boolean isSetNotebookGuid()

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

setNotebookGuidIsSet

public void setNotebookGuidIsSet(boolean value)

getTagGuidsSize

public int getTagGuidsSize()

getTagGuidsIterator

public Iterator<String> getTagGuidsIterator()

addToTagGuids

public void addToTagGuids(String elem)

getTagGuids

public List<String> getTagGuids()

setTagGuids

public void setTagGuids(List<String> tagGuids)

unsetTagGuids

public void unsetTagGuids()

isSetTagGuids

public boolean isSetTagGuids()

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

setTagGuidsIsSet

public void setTagGuidsIsSet(boolean value)

getTimeZone

public String getTimeZone()

setTimeZone

public void setTimeZone(String timeZone)

unsetTimeZone

public void unsetTimeZone()

isSetTimeZone

public boolean isSetTimeZone()

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

setTimeZoneIsSet

public void setTimeZoneIsSet(boolean value)

isInactive

public boolean isInactive()

setInactive

public void setInactive(boolean inactive)

unsetInactive

public void unsetInactive()

isSetInactive

public boolean isSetInactive()

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

setInactiveIsSet

public void setInactiveIsSet(boolean value)

getEmphasized

public String getEmphasized()

setEmphasized

public void setEmphasized(String emphasized)

unsetEmphasized

public void unsetEmphasized()

isSetEmphasized

public boolean isSetEmphasized()

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

setEmphasizedIsSet

public void setEmphasizedIsSet(boolean value)

equals

public boolean equals(Object that)

Overrides:

equals in class Object

equals

public boolean equals(NoteFilter that)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

compareTo

public int compareTo(NoteFilter other)

Specified by:

compareTo in interface Comparable<NoteFilter>

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

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

Parameters:

oprot - Output protocol

Throws:

TException

toString

public String toString()

Overrides:

toString in class Object

validate

public void validate()
              throws TException

Throws:

TException