com.evernote.edam.type
Class Notebook

java.lang.Object
  extended by com.evernote.edam.type.Notebook
All Implemented Interfaces:
java.io.Serializable, java.lang.Cloneable, java.lang.Comparable<Notebook>, org.apache.thrift.TBase<Notebook._Fields>

public class Notebook
extends java.lang.Object
implements org.apache.thrift.TBase<Notebook._Fields>, java.io.Serializable, java.lang.Cloneable, java.lang.Comparable<Notebook>

A unique container for a set of notes.

guid
The unique identifier of this notebook.
Length: EDAM_GUID_LEN_MIN - EDAM_GUID_LEN_MAX
Regex: EDAM_GUID_REGEX
name
A sequence of characters representing the name of the notebook. May be changed by clients, but the account may not contain two notebooks with names that are equal via a case-insensitive comparison. Can't begin or end with a space.
Length: EDAM_NOTEBOOK_NAME_LEN_MIN - EDAM_NOTEBOOK_NAME_LEN_MAX
Regex: EDAM_NOTEBOOK_NAME_REGEX
updateSequenceNum
A number identifying the last transaction to modify the state of this object. The USN values are sequential within an account, and can be used to compare the order of modifications within the service.
defaultNotebook
If true, this notebook should be used for new notes whenever the user has not (or cannot) specify a desired target notebook. For example, if a note is submitted via SMTP email. The service will maintain at most one defaultNotebook per account. If a second notebook is created or updated with defaultNotebook set to true, the service will automatically update the prior notebook's defaultNotebook field to false. If the default notebook is deleted (i.e. "active" set to false), the "defaultNotebook" field will be set to false by the service. If the account has no default notebook set, the service will use the most recent notebook as the default.
serviceCreated
The time when this notebook was created on the service. This will be set on the service during creation, and the service will provide this value when it returns a Notebook to a client. The service will ignore this value if it is sent by clients.
serviceUpdated
The time when this notebook was last modified on the service. This will be set on the service during creation, and the service will provide this value when it returns a Notebook to a client. The service will ignore this value if it is sent by clients.
publishing
If the Notebook has been opened for public access (i.e. if 'published' is set to true), then this will point to the set of publishing information for the Notebook (URI, description, etc.). A Notebook cannot be published without providing this information, but it will persist for later use if publishing is ever disabled on the Notebook. Clients that do not wish to change the publishing behavior of a Notebook should not set this value when calling NoteStore.updateNotebook().
published
If this is set to true, then the Notebook will be accessible to the public via the 'publishing' specification, which must also be set. If this is set to false, the Notebook will not be available to the public. Clients that do not wish to change the publishing behavior of a Notebook should not set this value when calling NoteStore.updateNotebook().

See Also:
Serialized Form

Nested Class Summary
static class Notebook._Fields
          The set of fields this struct contains, along with convenience methods for finding and manipulating them.
 
Field Summary
static java.util.Map<Notebook._Fields,org.apache.thrift.meta_data.FieldMetaData> metaDataMap
           
 
Constructor Summary
Notebook()
           
Notebook(Notebook other)
          Performs a deep copy on other.
 
Method Summary
 Notebook clone()
          Deprecated. 
 int compareTo(Notebook other)
           
 Notebook deepCopy()
           
 boolean equals(Notebook that)
           
 boolean equals(java.lang.Object that)
           
 java.lang.Object getFieldValue(int fieldId)
           
 java.lang.Object getFieldValue(Notebook._Fields field)
           
 java.lang.String getGuid()
           
 java.lang.String getName()
           
 Publishing getPublishing()
           
 long getServiceCreated()
           
 long getServiceUpdated()
           
 int getUpdateSequenceNum()
           
 int hashCode()
           
 boolean isDefaultNotebook()
           
 boolean isPublished()
           
 boolean isSet(int fieldID)
           
 boolean isSet(Notebook._Fields field)
          Returns true if field corresponding to fieldID is set (has been asigned a value) and false otherwise
 boolean isSetDefaultNotebook()
          Returns true if field defaultNotebook is set (has been asigned a value) and false otherwise
 boolean isSetGuid()
          Returns true if field guid is set (has been asigned a value) and false otherwise
 boolean isSetName()
          Returns true if field name is set (has been asigned a value) and false otherwise
 boolean isSetPublished()
          Returns true if field published is set (has been asigned a value) and false otherwise
 boolean isSetPublishing()
          Returns true if field publishing is set (has been asigned a value) and false otherwise
 boolean isSetServiceCreated()
          Returns true if field serviceCreated is set (has been asigned a value) and false otherwise
 boolean isSetServiceUpdated()
          Returns true if field serviceUpdated is set (has been asigned a value) and false otherwise
 boolean isSetUpdateSequenceNum()
          Returns true if field updateSequenceNum is set (has been asigned a value) and false otherwise
 void read(org.apache.thrift.protocol.TProtocol iprot)
           
 void setDefaultNotebook(boolean defaultNotebook)
           
 void setDefaultNotebookIsSet(boolean value)
           
 void setFieldValue(int fieldID, java.lang.Object value)
           
 void setFieldValue(Notebook._Fields field, java.lang.Object value)
           
 void setGuid(java.lang.String guid)
           
 void setGuidIsSet(boolean value)
           
 void setName(java.lang.String name)
           
 void setNameIsSet(boolean value)
           
 void setPublished(boolean published)
           
 void setPublishedIsSet(boolean value)
           
 void setPublishing(Publishing publishing)
           
 void setPublishingIsSet(boolean value)
           
 void setServiceCreated(long serviceCreated)
           
 void setServiceCreatedIsSet(boolean value)
           
 void setServiceUpdated(long serviceUpdated)
           
 void setServiceUpdatedIsSet(boolean value)
           
 void setUpdateSequenceNum(int updateSequenceNum)
           
 void setUpdateSequenceNumIsSet(boolean value)
           
 java.lang.String toString()
           
 void unsetDefaultNotebook()
           
 void unsetGuid()
           
 void unsetName()
           
 void unsetPublished()
           
 void unsetPublishing()
           
 void unsetServiceCreated()
           
 void unsetServiceUpdated()
           
 void unsetUpdateSequenceNum()
           
 void validate()
           
 void write(org.apache.thrift.protocol.TProtocol oprot)
           
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

metaDataMap

public static final java.util.Map<Notebook._Fields,org.apache.thrift.meta_data.FieldMetaData> metaDataMap
Constructor Detail

Notebook

public Notebook()

Notebook

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

Method Detail

deepCopy

public Notebook deepCopy()
Specified by:
deepCopy in interface org.apache.thrift.TBase<Notebook._Fields>

clone

@Deprecated
public Notebook clone()
Deprecated. 

Overrides:
clone in class java.lang.Object

getGuid

public java.lang.String getGuid()

setGuid

public void setGuid(java.lang.String guid)

unsetGuid

public void unsetGuid()

isSetGuid

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


setGuidIsSet

public void setGuidIsSet(boolean value)

getName

public java.lang.String getName()

setName

public void setName(java.lang.String name)

unsetName

public void unsetName()

isSetName

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


setNameIsSet

public void setNameIsSet(boolean value)

getUpdateSequenceNum

public int getUpdateSequenceNum()

setUpdateSequenceNum

public void setUpdateSequenceNum(int updateSequenceNum)

unsetUpdateSequenceNum

public void unsetUpdateSequenceNum()

isSetUpdateSequenceNum

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


setUpdateSequenceNumIsSet

public void setUpdateSequenceNumIsSet(boolean value)

isDefaultNotebook

public boolean isDefaultNotebook()

setDefaultNotebook

public void setDefaultNotebook(boolean defaultNotebook)

unsetDefaultNotebook

public void unsetDefaultNotebook()

isSetDefaultNotebook

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


setDefaultNotebookIsSet

public void setDefaultNotebookIsSet(boolean value)

getServiceCreated

public long getServiceCreated()

setServiceCreated

public void setServiceCreated(long serviceCreated)

unsetServiceCreated

public void unsetServiceCreated()

isSetServiceCreated

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


setServiceCreatedIsSet

public void setServiceCreatedIsSet(boolean value)

getServiceUpdated

public long getServiceUpdated()

setServiceUpdated

public void setServiceUpdated(long serviceUpdated)

unsetServiceUpdated

public void unsetServiceUpdated()

isSetServiceUpdated

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


setServiceUpdatedIsSet

public void setServiceUpdatedIsSet(boolean value)

getPublishing

public Publishing getPublishing()

setPublishing

public void setPublishing(Publishing publishing)

unsetPublishing

public void unsetPublishing()

isSetPublishing

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


setPublishingIsSet

public void setPublishingIsSet(boolean value)

isPublished

public boolean isPublished()

setPublished

public void setPublished(boolean published)

unsetPublished

public void unsetPublished()

isSetPublished

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


setPublishedIsSet

public void setPublishedIsSet(boolean value)

setFieldValue

public void setFieldValue(Notebook._Fields field,
                          java.lang.Object value)
Specified by:
setFieldValue in interface org.apache.thrift.TBase<Notebook._Fields>

setFieldValue

public void setFieldValue(int fieldID,
                          java.lang.Object value)
Specified by:
setFieldValue in interface org.apache.thrift.TBase<Notebook._Fields>

getFieldValue

public java.lang.Object getFieldValue(Notebook._Fields field)
Specified by:
getFieldValue in interface org.apache.thrift.TBase<Notebook._Fields>

getFieldValue

public java.lang.Object getFieldValue(int fieldId)
Specified by:
getFieldValue in interface org.apache.thrift.TBase<Notebook._Fields>

isSet

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

Specified by:
isSet in interface org.apache.thrift.TBase<Notebook._Fields>

isSet

public boolean isSet(int fieldID)
Specified by:
isSet in interface org.apache.thrift.TBase<Notebook._Fields>

equals

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

equals

public boolean equals(Notebook that)

hashCode

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

compareTo

public int compareTo(Notebook other)
Specified by:
compareTo in interface java.lang.Comparable<Notebook>

read

public void read(org.apache.thrift.protocol.TProtocol iprot)
          throws org.apache.thrift.TException
Specified by:
read in interface org.apache.thrift.TBase<Notebook._Fields>
Throws:
org.apache.thrift.TException

write

public void write(org.apache.thrift.protocol.TProtocol oprot)
           throws org.apache.thrift.TException
Specified by:
write in interface org.apache.thrift.TBase<Notebook._Fields>
Throws:
org.apache.thrift.TException

toString

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

validate

public void validate()
              throws org.apache.thrift.TException
Throws:
org.apache.thrift.TException