com.evernote.edam.notestore
Class SyncChunkFilter

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

All Implemented Interfaces:

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

public class SyncChunkFilter
extends java.lang.Object
implements com.evernote.thrift.TBase<SyncChunkFilter>, 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.

includeNoteApplicationDataFullMap

If true, then the values for the applicationData map will be filled in, assuming notes and note attributes are being returned. Otherwise, only the keysOnly field will be filled in.

includeResourceApplicationDataFullMap

If true, then the fullMap values for the applicationData map will be filled in, assuming resources and resource attributes are being returned (includeResources is true). Otherwise, only the keysOnly field will be filled in.

includeNoteResourceApplicationDataFullMap

If true, then the fullMap values for the applicationData map will be filled in for resources found inside of notes, assuming resources are being returned in notes (includeNoteResources is true). Otherwise, only the keysOnly field will be filled in.

requireNoteContentClass

If set, then only send notes whose content class matches this value. The value can be a literal match or, if the last character is an asterisk, a prefix match.

See Also:

Serialized Form

Constructor Summary

SyncChunkFilter()

SyncChunkFilter(SyncChunkFilter 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(SyncChunkFilter other)
SyncChunkFilter	deepCopy() Creates a deep copy of the object.
boolean	equals(java.lang.Object that)
boolean	equals(SyncChunkFilter that)
java.lang.String	getRequireNoteContentClass()
int	hashCode()
boolean	isIncludeExpunged()
boolean	isIncludeLinkedNotebooks()
boolean	isIncludeNoteApplicationDataFullMap()
boolean	isIncludeNoteAttributes()
boolean	isIncludeNotebooks()
boolean	isIncludeNoteResourceApplicationDataFullMap()
boolean	isIncludeNoteResources()
boolean	isIncludeNotes()
boolean	isIncludeResourceApplicationDataFullMap()
boolean	isIncludeResources()
boolean	isIncludeSearches()
boolean	isIncludeTags()
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	isSetIncludeNoteApplicationDataFullMap() Returns true if field includeNoteApplicationDataFullMap 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	isSetIncludeNoteResourceApplicationDataFullMap() Returns true if field includeNoteResourceApplicationDataFullMap 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	isSetIncludeResourceApplicationDataFullMap() Returns true if field includeResourceApplicationDataFullMap 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
boolean	isSetRequireNoteContentClass() Returns true if field requireNoteContentClass 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	setIncludeExpunged(boolean includeExpunged)
void	setIncludeExpungedIsSet(boolean value)
void	setIncludeLinkedNotebooks(boolean includeLinkedNotebooks)
void	setIncludeLinkedNotebooksIsSet(boolean value)
void	setIncludeNoteApplicationDataFullMap(boolean includeNoteApplicationDataFullMap)
void	setIncludeNoteApplicationDataFullMapIsSet(boolean value)
void	setIncludeNoteAttributes(boolean includeNoteAttributes)
void	setIncludeNoteAttributesIsSet(boolean value)
void	setIncludeNotebooks(boolean includeNotebooks)
void	setIncludeNotebooksIsSet(boolean value)
void	setIncludeNoteResourceApplicationDataFullMap(boolean includeNoteResourceApplicationDataFullMap)
void	setIncludeNoteResourceApplicationDataFullMapIsSet(boolean value)
void	setIncludeNoteResources(boolean includeNoteResources)
void	setIncludeNoteResourcesIsSet(boolean value)
void	setIncludeNotes(boolean includeNotes)
void	setIncludeNotesIsSet(boolean value)
void	setIncludeResourceApplicationDataFullMap(boolean includeResourceApplicationDataFullMap)
void	setIncludeResourceApplicationDataFullMapIsSet(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)
void	setRequireNoteContentClass(java.lang.String requireNoteContentClass)
void	setRequireNoteContentClassIsSet(boolean value)
java.lang.String	toString()
void	unsetIncludeExpunged()
void	unsetIncludeLinkedNotebooks()
void	unsetIncludeNoteApplicationDataFullMap()
void	unsetIncludeNoteAttributes()
void	unsetIncludeNotebooks()
void	unsetIncludeNoteResourceApplicationDataFullMap()
void	unsetIncludeNoteResources()
void	unsetIncludeNotes()
void	unsetIncludeResourceApplicationDataFullMap()
void	unsetIncludeResources()
void	unsetIncludeSearches()
void	unsetIncludeTags()
void	unsetRequireNoteContentClass()
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

SyncChunkFilter

public SyncChunkFilter()

SyncChunkFilter

public SyncChunkFilter(SyncChunkFilter other)

Performs a deep copy on other.

Method Detail

deepCopy

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

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

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)

isIncludeNoteApplicationDataFullMap

public boolean isIncludeNoteApplicationDataFullMap()

setIncludeNoteApplicationDataFullMap

public void setIncludeNoteApplicationDataFullMap(boolean includeNoteApplicationDataFullMap)

unsetIncludeNoteApplicationDataFullMap

public void unsetIncludeNoteApplicationDataFullMap()

isSetIncludeNoteApplicationDataFullMap

public boolean isSetIncludeNoteApplicationDataFullMap()

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

setIncludeNoteApplicationDataFullMapIsSet

public void setIncludeNoteApplicationDataFullMapIsSet(boolean value)

isIncludeResourceApplicationDataFullMap

public boolean isIncludeResourceApplicationDataFullMap()

setIncludeResourceApplicationDataFullMap

public void setIncludeResourceApplicationDataFullMap(boolean includeResourceApplicationDataFullMap)

unsetIncludeResourceApplicationDataFullMap

public void unsetIncludeResourceApplicationDataFullMap()

isSetIncludeResourceApplicationDataFullMap

public boolean isSetIncludeResourceApplicationDataFullMap()

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

setIncludeResourceApplicationDataFullMapIsSet

public void setIncludeResourceApplicationDataFullMapIsSet(boolean value)

isIncludeNoteResourceApplicationDataFullMap

public boolean isIncludeNoteResourceApplicationDataFullMap()

setIncludeNoteResourceApplicationDataFullMap

public void setIncludeNoteResourceApplicationDataFullMap(boolean includeNoteResourceApplicationDataFullMap)

unsetIncludeNoteResourceApplicationDataFullMap

public void unsetIncludeNoteResourceApplicationDataFullMap()

isSetIncludeNoteResourceApplicationDataFullMap

public boolean isSetIncludeNoteResourceApplicationDataFullMap()

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

setIncludeNoteResourceApplicationDataFullMapIsSet

public void setIncludeNoteResourceApplicationDataFullMapIsSet(boolean value)

getRequireNoteContentClass

public java.lang.String getRequireNoteContentClass()

setRequireNoteContentClass

public void setRequireNoteContentClass(java.lang.String requireNoteContentClass)

unsetRequireNoteContentClass

public void unsetRequireNoteContentClass()

isSetRequireNoteContentClass

public boolean isSetRequireNoteContentClass()

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

setRequireNoteContentClassIsSet

public void setRequireNoteContentClassIsSet(boolean value)

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)

Specified by:

compareTo in interface java.lang.Comparable<SyncChunkFilter>

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

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

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