com.evernote.edam.notestore
Class SyncChunkFilter

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

public class SyncChunkFilter
extends java.lang.Object
implements java.io.Serializable, java.lang.Cloneable

This structure is used with the 'getFilteredSyncChunk' call to provide fine-grained control over the data that's returned when a client needs to synchronize with the service. Each flag in this structure specifies whether to include one class of data in the results of that call.

includeNotes
If true, then the server will include the SyncChunks.notes field
includeNoteResources
If true, then the server will include the 'resources' field on all of the Notes that are in SyncChunk.notes. If 'includeNotes' is false, then this will have no effect.
includeNoteAttributes
If true, then the server will include the 'attributes' field on all of the Notes that are in SyncChunks.notes. If 'includeNotes' is false, then this will have no effect.
includeNotebooks
If true, then the server will include the SyncChunks.notebooks field
includeTags
If true, then the server will include the SyncChunks.tags field
includeSearches
If true, then the server will include the SyncChunks.searches field
includeResources
If true, then the server will include the SyncChunks.resources field. Since the Resources are also provided with their Note (in the Notes.resources list), this is primarily useful for clients that want to watch for changes to individual Resources due to recognition data being added.
includeLinkedNotebooks
If true, then the server will include the SyncChunks.linkedNotebooks field.
includeExpunged
If true, then the server will include the 'expunged' data for any type of included data. For example, if 'includeTags' and 'includeExpunged' are both true, then the SyncChunks.expungedTags field will be set with the GUIDs of tags that have been expunged from the server.

See Also:
Serialized Form

Nested Class Summary
static class SyncChunkFilter._Fields
          The set of fields this struct contains, along with convenience methods for finding and manipulating them.
 
Field Summary
static java.util.Map<SyncChunkFilter._Fields,FieldMetaData> metaDataMap
           
 
Constructor Summary
SyncChunkFilter()
           
SyncChunkFilter(SyncChunkFilter other)
          Performs a deep copy on other.
 
Method Summary
 void clear()
           
 int compareTo(SyncChunkFilter other)
           
 SyncChunkFilter deepCopy()
           
 boolean equals(java.lang.Object that)
           
 boolean equals(SyncChunkFilter that)
           
 SyncChunkFilter._Fields fieldForId(int fieldId)
           
 java.lang.Object getFieldValue(SyncChunkFilter._Fields field)
           
 int hashCode()
           
 boolean isIncludeExpunged()
           
 boolean isIncludeLinkedNotebooks()
           
 boolean isIncludeNoteAttributes()
           
 boolean isIncludeNotebooks()
           
 boolean isIncludeNoteResources()
           
 boolean isIncludeNotes()
           
 boolean isIncludeResources()
           
 boolean isIncludeSearches()
           
 boolean isIncludeTags()
           
 boolean isSet(SyncChunkFilter._Fields field)
          Returns true if field corresponding to fieldID is set (has been asigned a value) and false otherwise
 boolean isSetIncludeExpunged()
          Returns true if field includeExpunged is set (has been asigned a value) and false otherwise
 boolean isSetIncludeLinkedNotebooks()
          Returns true if field includeLinkedNotebooks is set (has been asigned a value) and false otherwise
 boolean isSetIncludeNoteAttributes()
          Returns true if field includeNoteAttributes is set (has been asigned a value) and false otherwise
 boolean isSetIncludeNotebooks()
          Returns true if field includeNotebooks is set (has been asigned a value) and false otherwise
 boolean isSetIncludeNoteResources()
          Returns true if field includeNoteResources is set (has been asigned a value) and false otherwise
 boolean isSetIncludeNotes()
          Returns true if field includeNotes is set (has been asigned a value) and false otherwise
 boolean isSetIncludeResources()
          Returns true if field includeResources is set (has been asigned a value) and false otherwise
 boolean isSetIncludeSearches()
          Returns true if field includeSearches is set (has been asigned a value) and false otherwise
 boolean isSetIncludeTags()
          Returns true if field includeTags is set (has been asigned a value) and false otherwise
 void read(TProtocol iprot)
           
 void setFieldValue(SyncChunkFilter._Fields field, java.lang.Object value)
           
 void setIncludeExpunged(boolean includeExpunged)
           
 void setIncludeExpungedIsSet(boolean value)
           
 void setIncludeLinkedNotebooks(boolean includeLinkedNotebooks)
           
 void setIncludeLinkedNotebooksIsSet(boolean value)
           
 void setIncludeNoteAttributes(boolean includeNoteAttributes)
           
 void setIncludeNoteAttributesIsSet(boolean value)
           
 void setIncludeNotebooks(boolean includeNotebooks)
           
 void setIncludeNotebooksIsSet(boolean value)
           
 void setIncludeNoteResources(boolean includeNoteResources)
           
 void setIncludeNoteResourcesIsSet(boolean value)
           
 void setIncludeNotes(boolean includeNotes)
           
 void setIncludeNotesIsSet(boolean value)
           
 void setIncludeResources(boolean includeResources)
           
 void setIncludeResourcesIsSet(boolean value)
           
 void setIncludeSearches(boolean includeSearches)
           
 void setIncludeSearchesIsSet(boolean value)
           
 void setIncludeTags(boolean includeTags)
           
 void setIncludeTagsIsSet(boolean value)
           
 java.lang.String toString()
           
 void unsetIncludeExpunged()
           
 void unsetIncludeLinkedNotebooks()
           
 void unsetIncludeNoteAttributes()
           
 void unsetIncludeNotebooks()
           
 void unsetIncludeNoteResources()
           
 void unsetIncludeNotes()
           
 void unsetIncludeResources()
           
 void unsetIncludeSearches()
           
 void unsetIncludeTags()
           
 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<SyncChunkFilter._Fields,FieldMetaData> metaDataMap
Constructor Detail

SyncChunkFilter

public SyncChunkFilter()

SyncChunkFilter

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

Method Detail

deepCopy

public SyncChunkFilter deepCopy()

clear

public void clear()

isIncludeNotes

public boolean isIncludeNotes()

setIncludeNotes

public void setIncludeNotes(boolean includeNotes)

unsetIncludeNotes

public void unsetIncludeNotes()

isSetIncludeNotes

public boolean isSetIncludeNotes()
Returns true if field includeNotes is set (has been asigned a value) and false otherwise


setIncludeNotesIsSet

public void setIncludeNotesIsSet(boolean value)

isIncludeNoteResources

public boolean isIncludeNoteResources()

setIncludeNoteResources

public void setIncludeNoteResources(boolean includeNoteResources)

unsetIncludeNoteResources

public void unsetIncludeNoteResources()

isSetIncludeNoteResources

public boolean isSetIncludeNoteResources()
Returns true if field includeNoteResources is set (has been asigned a value) and false otherwise


setIncludeNoteResourcesIsSet

public void setIncludeNoteResourcesIsSet(boolean value)

isIncludeNoteAttributes

public boolean isIncludeNoteAttributes()

setIncludeNoteAttributes

public void setIncludeNoteAttributes(boolean includeNoteAttributes)

unsetIncludeNoteAttributes

public void unsetIncludeNoteAttributes()

isSetIncludeNoteAttributes

public boolean isSetIncludeNoteAttributes()
Returns true if field includeNoteAttributes is set (has been asigned a value) and false otherwise


setIncludeNoteAttributesIsSet

public void setIncludeNoteAttributesIsSet(boolean value)

isIncludeNotebooks

public boolean isIncludeNotebooks()

setIncludeNotebooks

public void setIncludeNotebooks(boolean includeNotebooks)

unsetIncludeNotebooks

public void unsetIncludeNotebooks()

isSetIncludeNotebooks

public boolean isSetIncludeNotebooks()
Returns true if field includeNotebooks is set (has been asigned a value) and false otherwise


setIncludeNotebooksIsSet

public void setIncludeNotebooksIsSet(boolean value)

isIncludeTags

public boolean isIncludeTags()

setIncludeTags

public void setIncludeTags(boolean includeTags)

unsetIncludeTags

public void unsetIncludeTags()

isSetIncludeTags

public boolean isSetIncludeTags()
Returns true if field includeTags is set (has been asigned a value) and false otherwise


setIncludeTagsIsSet

public void setIncludeTagsIsSet(boolean value)

isIncludeSearches

public boolean isIncludeSearches()

setIncludeSearches

public void setIncludeSearches(boolean includeSearches)

unsetIncludeSearches

public void unsetIncludeSearches()

isSetIncludeSearches

public boolean isSetIncludeSearches()
Returns true if field includeSearches is set (has been asigned a value) and false otherwise


setIncludeSearchesIsSet

public void setIncludeSearchesIsSet(boolean value)

isIncludeResources

public boolean isIncludeResources()

setIncludeResources

public void setIncludeResources(boolean includeResources)

unsetIncludeResources

public void unsetIncludeResources()

isSetIncludeResources

public boolean isSetIncludeResources()
Returns true if field includeResources is set (has been asigned a value) and false otherwise


setIncludeResourcesIsSet

public void setIncludeResourcesIsSet(boolean value)

isIncludeLinkedNotebooks

public boolean isIncludeLinkedNotebooks()

setIncludeLinkedNotebooks

public void setIncludeLinkedNotebooks(boolean includeLinkedNotebooks)

unsetIncludeLinkedNotebooks

public void unsetIncludeLinkedNotebooks()

isSetIncludeLinkedNotebooks

public boolean isSetIncludeLinkedNotebooks()
Returns true if field includeLinkedNotebooks is set (has been asigned a value) and false otherwise


setIncludeLinkedNotebooksIsSet

public void setIncludeLinkedNotebooksIsSet(boolean value)

isIncludeExpunged

public boolean isIncludeExpunged()

setIncludeExpunged

public void setIncludeExpunged(boolean includeExpunged)

unsetIncludeExpunged

public void unsetIncludeExpunged()

isSetIncludeExpunged

public boolean isSetIncludeExpunged()
Returns true if field includeExpunged is set (has been asigned a value) and false otherwise


setIncludeExpungedIsSet

public void setIncludeExpungedIsSet(boolean value)

setFieldValue

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

getFieldValue

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

isSet

public boolean isSet(SyncChunkFilter._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(SyncChunkFilter that)

hashCode

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

compareTo

public int compareTo(SyncChunkFilter other)

fieldForId

public SyncChunkFilter._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