com.evernote.edam.notestore
Class NoteFilter

java.lang.Object
  extended by com.evernote.edam.notestore.NoteFilter
All Implemented Interfaces:
java.io.Serializable, java.lang.Cloneable

public class NoteFilter
extends java.lang.Object
implements java.io.Serializable, java.lang.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.

See Also:
Serialized Form

Nested Class Summary
static class NoteFilter._Fields
          The set of fields this struct contains, along with convenience methods for finding and manipulating them.
 
Field Summary
static java.util.Map<NoteFilter._Fields,FieldMetaData> metaDataMap
           
 
Constructor Summary
NoteFilter()
           
NoteFilter(NoteFilter other)
          Performs a deep copy on other.
 
Method Summary
 void addToTagGuids(java.lang.String elem)
           
 void clear()
           
 int compareTo(NoteFilter other)
           
 NoteFilter deepCopy()
           
 boolean equals(NoteFilter that)
           
 boolean equals(java.lang.Object that)
           
 NoteFilter._Fields fieldForId(int fieldId)
           
 java.lang.Object getFieldValue(NoteFilter._Fields field)
           
 java.lang.String getNotebookGuid()
           
 int getOrder()
           
 java.util.List<java.lang.String> getTagGuids()
           
 java.util.Iterator<java.lang.String> getTagGuidsIterator()
           
 int getTagGuidsSize()
           
 java.lang.String getTimeZone()
           
 java.lang.String getWords()
           
 int hashCode()
           
 boolean isAscending()
           
 boolean isInactive()
           
 boolean isSet(NoteFilter._Fields field)
          Returns true if field corresponding to fieldID is set (has been asigned a value) and false otherwise
 boolean isSetAscending()
          Returns true if field ascending 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)
           
 void setAscending(boolean ascending)
           
 void setAscendingIsSet(boolean value)
           
 void setFieldValue(NoteFilter._Fields field, java.lang.Object value)
           
 void setInactive(boolean inactive)
           
 void setInactiveIsSet(boolean value)
           
 void setNotebookGuid(java.lang.String notebookGuid)
           
 void setNotebookGuidIsSet(boolean value)
           
 void setOrder(int order)
           
 void setOrderIsSet(boolean value)
           
 void setTagGuids(java.util.List<java.lang.String> tagGuids)
           
 void setTagGuidsIsSet(boolean value)
           
 void setTimeZone(java.lang.String timeZone)
           
 void setTimeZoneIsSet(boolean value)
           
 void setWords(java.lang.String words)
           
 void setWordsIsSet(boolean value)
           
 java.lang.String toString()
           
 void unsetAscending()
           
 void unsetInactive()
           
 void unsetNotebookGuid()
           
 void unsetOrder()
           
 void unsetTagGuids()
           
 void unsetTimeZone()
           
 void unsetWords()
           
 void validate()
           
 void write(TProtocol oprot)
           
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

metaDataMap

public static final java.util.Map<NoteFilter._Fields,FieldMetaData> metaDataMap
Constructor Detail

NoteFilter

public NoteFilter()

NoteFilter

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

Method Detail

deepCopy

public NoteFilter deepCopy()

clear

public void clear()

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 java.lang.String getWords()

setWords

public void setWords(java.lang.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 java.lang.String getNotebookGuid()

setNotebookGuid

public void setNotebookGuid(java.lang.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 java.util.Iterator<java.lang.String> getTagGuidsIterator()

addToTagGuids

public void addToTagGuids(java.lang.String elem)

getTagGuids

public java.util.List<java.lang.String> getTagGuids()

setTagGuids

public void setTagGuids(java.util.List<java.lang.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 java.lang.String getTimeZone()

setTimeZone

public void setTimeZone(java.lang.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)

setFieldValue

public void setFieldValue(NoteFilter._Fields field,
                          java.lang.Object value)

getFieldValue

public java.lang.Object getFieldValue(NoteFilter._Fields field)

isSet

public boolean isSet(NoteFilter._Fields field)
Returns true if field corresponding to fieldID is set (has been asigned a value) and false otherwise


equals

public boolean equals(java.lang.Object that)
Overrides:
equals in class java.lang.Object

equals

public boolean equals(NoteFilter that)

hashCode

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

compareTo

public int compareTo(NoteFilter other)

fieldForId

public NoteFilter._Fields fieldForId(int fieldId)

read

public void read(TProtocol iprot)
          throws TException
Throws:
TException

write

public void write(TProtocol oprot)
           throws TException
Throws:
TException

toString

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

validate

public void validate()
              throws TException
Throws:
TException