com.evernote.edam.type
Class NotebookRestrictions

java.lang.Object
  com.evernote.edam.type.NotebookRestrictions

All Implemented Interfaces:

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

public class NotebookRestrictions
extends java.lang.Object
implements com.evernote.thrift.TBase<NotebookRestrictions>, java.io.Serializable, java.lang.Cloneable

This structure captures information about the types of operations that cannot be performed on a given notebook with a type of authenticated access and credentials. The values filled into this structure are based on then-current values in the server database for shared notebooks and notebook publishing records, as well as information related to the authentication token. Information from the authentication token includes the application that is accessing the server, as defined by the permissions granted by consumer (api) key, and the method used to obtain the token, for example via authenticateToSharedNotebook, authenticateToBusiness, etc. Note that changes to values in this structure that are the result of shared notebook or publishing record changes are communicated to the client via a change in the notebook USN during sync. It is important to use the same access method, parameters, and consumer key in order obtain correct results from the sync engine. The server has the final say on what is allowed as values may change between calls to obtain NotebookRestrictions instances and to operate on data on the service. If the following are set and true, then the given restriction is in effect, as accessed by the same authentication token from which the values were obtained.

noReadNotes

The client is not able to read notes from the service and the notebook is write-only.

noCreateNotes

The client may not create new notes in the notebook.

noUpdateNotes

The client may not update notes currently in the notebook.

noExpungeNotes

The client may not expunge notes currently in the notebook.

noShareNotes

The client may not share notes in the notebook via the shareNote method.

noEmailNotes

The client may not e-mail notes via the Evernote service by using the emailNote method.

noSendMessageToRecipients

The client may not send messages to the share recipients of the notebook.

noUpdateNotebook

The client may not update the Notebook object itself, for example, via the updateNotebook method.

noExpungeNotebook

The client may not expunge the Notebook object itself, for example, via the expungeNotebook method.

noSetDefaultNotebook

The client may not set this notebook to be the default notebook. The caller should leave Notebook.defaultNotebook unset.

noSetNotebookStack

If the client is able to update the Notebook, the Notebook.stack value may not be set.

noPublishToPublic

The client may not change the publish the notebook to the public. For example, business notebooks may not be shared publicly.

noPublishToBusinessLibrary

The client may not publish the notebook to the business library.

noCreateTags

The client may not complete an operation that results in a new tag being created in the owner's account.

noUpdateTags

The client may not update tags in the owner's account.

noExpungeTags

The client may not expunge tags in the owner's account.

noSetParentTag

If the client is able to create or update tags in the owner's account, then they will not be able to set the parent tag. Leave the value unset.

noCreateSharedNotebooks

The client is unable to create shared notebooks for the notebook.

updateWhichSharedNotebookRestrictions

Restrictions on which shared notebook instances can be updated. If the value is not set or null, then the client can update any of the shared notebooks associated with the notebook on which the NotebookRestrictions are defined. See the enumeration for further details.

expungeWhichSharedNotebookRestrictions

Restrictions on which shared notebook instances can be expunged. If the value is not set or null, then the client can expunge any of the shared notebooks associated with the notebook on which the NotebookRestrictions are defined. See the enumeration for further details.

See Also:

Serialized Form

Constructor Summary

NotebookRestrictions()

NotebookRestrictions(NotebookRestrictions 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(NotebookRestrictions other)
NotebookRestrictions	deepCopy() Creates a deep copy of the object.
boolean	equals(NotebookRestrictions that)
boolean	equals(java.lang.Object that)
SharedNotebookInstanceRestrictions	getExpungeWhichSharedNotebookRestrictions()
SharedNotebookInstanceRestrictions	getUpdateWhichSharedNotebookRestrictions()
int	hashCode()
boolean	isNoCreateNotes()
boolean	isNoCreateSharedNotebooks()
boolean	isNoCreateTags()
boolean	isNoEmailNotes()
boolean	isNoExpungeNotebook()
boolean	isNoExpungeNotes()
boolean	isNoExpungeTags()
boolean	isNoPublishToBusinessLibrary()
boolean	isNoPublishToPublic()
boolean	isNoReadNotes()
boolean	isNoSendMessageToRecipients()
boolean	isNoSetDefaultNotebook()
boolean	isNoSetNotebookStack()
boolean	isNoSetParentTag()
boolean	isNoShareNotes()
boolean	isNoUpdateNotebook()
boolean	isNoUpdateNotes()
boolean	isNoUpdateTags()
boolean	isSetExpungeWhichSharedNotebookRestrictions() Returns true if field expungeWhichSharedNotebookRestrictions is set (has been asigned a value) and false otherwise
boolean	isSetNoCreateNotes() Returns true if field noCreateNotes is set (has been asigned a value) and false otherwise
boolean	isSetNoCreateSharedNotebooks() Returns true if field noCreateSharedNotebooks is set (has been asigned a value) and false otherwise
boolean	isSetNoCreateTags() Returns true if field noCreateTags is set (has been asigned a value) and false otherwise
boolean	isSetNoEmailNotes() Returns true if field noEmailNotes is set (has been asigned a value) and false otherwise
boolean	isSetNoExpungeNotebook() Returns true if field noExpungeNotebook is set (has been asigned a value) and false otherwise
boolean	isSetNoExpungeNotes() Returns true if field noExpungeNotes is set (has been asigned a value) and false otherwise
boolean	isSetNoExpungeTags() Returns true if field noExpungeTags is set (has been asigned a value) and false otherwise
boolean	isSetNoPublishToBusinessLibrary() Returns true if field noPublishToBusinessLibrary is set (has been asigned a value) and false otherwise
boolean	isSetNoPublishToPublic() Returns true if field noPublishToPublic is set (has been asigned a value) and false otherwise
boolean	isSetNoReadNotes() Returns true if field noReadNotes is set (has been asigned a value) and false otherwise
boolean	isSetNoSendMessageToRecipients() Returns true if field noSendMessageToRecipients is set (has been asigned a value) and false otherwise
boolean	isSetNoSetDefaultNotebook() Returns true if field noSetDefaultNotebook is set (has been asigned a value) and false otherwise
boolean	isSetNoSetNotebookStack() Returns true if field noSetNotebookStack is set (has been asigned a value) and false otherwise
boolean	isSetNoSetParentTag() Returns true if field noSetParentTag is set (has been asigned a value) and false otherwise
boolean	isSetNoShareNotes() Returns true if field noShareNotes is set (has been asigned a value) and false otherwise
boolean	isSetNoUpdateNotebook() Returns true if field noUpdateNotebook is set (has been asigned a value) and false otherwise
boolean	isSetNoUpdateNotes() Returns true if field noUpdateNotes is set (has been asigned a value) and false otherwise
boolean	isSetNoUpdateTags() Returns true if field noUpdateTags is set (has been asigned a value) and false otherwise
boolean	isSetUpdateWhichSharedNotebookRestrictions() Returns true if field updateWhichSharedNotebookRestrictions 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	setExpungeWhichSharedNotebookRestrictions(SharedNotebookInstanceRestrictions expungeWhichSharedNotebookRestrictions)
void	setExpungeWhichSharedNotebookRestrictionsIsSet(boolean value)
void	setNoCreateNotes(boolean noCreateNotes)
void	setNoCreateNotesIsSet(boolean value)
void	setNoCreateSharedNotebooks(boolean noCreateSharedNotebooks)
void	setNoCreateSharedNotebooksIsSet(boolean value)
void	setNoCreateTags(boolean noCreateTags)
void	setNoCreateTagsIsSet(boolean value)
void	setNoEmailNotes(boolean noEmailNotes)
void	setNoEmailNotesIsSet(boolean value)
void	setNoExpungeNotebook(boolean noExpungeNotebook)
void	setNoExpungeNotebookIsSet(boolean value)
void	setNoExpungeNotes(boolean noExpungeNotes)
void	setNoExpungeNotesIsSet(boolean value)
void	setNoExpungeTags(boolean noExpungeTags)
void	setNoExpungeTagsIsSet(boolean value)
void	setNoPublishToBusinessLibrary(boolean noPublishToBusinessLibrary)
void	setNoPublishToBusinessLibraryIsSet(boolean value)
void	setNoPublishToPublic(boolean noPublishToPublic)
void	setNoPublishToPublicIsSet(boolean value)
void	setNoReadNotes(boolean noReadNotes)
void	setNoReadNotesIsSet(boolean value)
void	setNoSendMessageToRecipients(boolean noSendMessageToRecipients)
void	setNoSendMessageToRecipientsIsSet(boolean value)
void	setNoSetDefaultNotebook(boolean noSetDefaultNotebook)
void	setNoSetDefaultNotebookIsSet(boolean value)
void	setNoSetNotebookStack(boolean noSetNotebookStack)
void	setNoSetNotebookStackIsSet(boolean value)
void	setNoSetParentTag(boolean noSetParentTag)
void	setNoSetParentTagIsSet(boolean value)
void	setNoShareNotes(boolean noShareNotes)
void	setNoShareNotesIsSet(boolean value)
void	setNoUpdateNotebook(boolean noUpdateNotebook)
void	setNoUpdateNotebookIsSet(boolean value)
void	setNoUpdateNotes(boolean noUpdateNotes)
void	setNoUpdateNotesIsSet(boolean value)
void	setNoUpdateTags(boolean noUpdateTags)
void	setNoUpdateTagsIsSet(boolean value)
void	setUpdateWhichSharedNotebookRestrictions(SharedNotebookInstanceRestrictions updateWhichSharedNotebookRestrictions)
void	setUpdateWhichSharedNotebookRestrictionsIsSet(boolean value)
java.lang.String	toString()
void	unsetExpungeWhichSharedNotebookRestrictions()
void	unsetNoCreateNotes()
void	unsetNoCreateSharedNotebooks()
void	unsetNoCreateTags()
void	unsetNoEmailNotes()
void	unsetNoExpungeNotebook()
void	unsetNoExpungeNotes()
void	unsetNoExpungeTags()
void	unsetNoPublishToBusinessLibrary()
void	unsetNoPublishToPublic()
void	unsetNoReadNotes()
void	unsetNoSendMessageToRecipients()
void	unsetNoSetDefaultNotebook()
void	unsetNoSetNotebookStack()
void	unsetNoSetParentTag()
void	unsetNoShareNotes()
void	unsetNoUpdateNotebook()
void	unsetNoUpdateNotes()
void	unsetNoUpdateTags()
void	unsetUpdateWhichSharedNotebookRestrictions()
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

NotebookRestrictions

public NotebookRestrictions()

NotebookRestrictions

public NotebookRestrictions(NotebookRestrictions other)

Performs a deep copy on other.

Method Detail

deepCopy

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

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

isNoReadNotes

public boolean isNoReadNotes()

setNoReadNotes

public void setNoReadNotes(boolean noReadNotes)

unsetNoReadNotes

public void unsetNoReadNotes()

isSetNoReadNotes

public boolean isSetNoReadNotes()

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

setNoReadNotesIsSet

public void setNoReadNotesIsSet(boolean value)

isNoCreateNotes

public boolean isNoCreateNotes()

setNoCreateNotes

public void setNoCreateNotes(boolean noCreateNotes)

unsetNoCreateNotes

public void unsetNoCreateNotes()

isSetNoCreateNotes

public boolean isSetNoCreateNotes()

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

setNoCreateNotesIsSet

public void setNoCreateNotesIsSet(boolean value)

isNoUpdateNotes

public boolean isNoUpdateNotes()

setNoUpdateNotes

public void setNoUpdateNotes(boolean noUpdateNotes)

unsetNoUpdateNotes

public void unsetNoUpdateNotes()

isSetNoUpdateNotes

public boolean isSetNoUpdateNotes()

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

setNoUpdateNotesIsSet

public void setNoUpdateNotesIsSet(boolean value)

isNoExpungeNotes

public boolean isNoExpungeNotes()

setNoExpungeNotes

public void setNoExpungeNotes(boolean noExpungeNotes)

unsetNoExpungeNotes

public void unsetNoExpungeNotes()

isSetNoExpungeNotes

public boolean isSetNoExpungeNotes()

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

setNoExpungeNotesIsSet

public void setNoExpungeNotesIsSet(boolean value)

isNoShareNotes

public boolean isNoShareNotes()

setNoShareNotes

public void setNoShareNotes(boolean noShareNotes)

unsetNoShareNotes

public void unsetNoShareNotes()

isSetNoShareNotes

public boolean isSetNoShareNotes()

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

setNoShareNotesIsSet

public void setNoShareNotesIsSet(boolean value)

isNoEmailNotes

public boolean isNoEmailNotes()

setNoEmailNotes

public void setNoEmailNotes(boolean noEmailNotes)

unsetNoEmailNotes

public void unsetNoEmailNotes()

isSetNoEmailNotes

public boolean isSetNoEmailNotes()

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

setNoEmailNotesIsSet

public void setNoEmailNotesIsSet(boolean value)

isNoSendMessageToRecipients

public boolean isNoSendMessageToRecipients()

setNoSendMessageToRecipients

public void setNoSendMessageToRecipients(boolean noSendMessageToRecipients)

unsetNoSendMessageToRecipients

public void unsetNoSendMessageToRecipients()

isSetNoSendMessageToRecipients

public boolean isSetNoSendMessageToRecipients()

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

setNoSendMessageToRecipientsIsSet

public void setNoSendMessageToRecipientsIsSet(boolean value)

isNoUpdateNotebook

public boolean isNoUpdateNotebook()

setNoUpdateNotebook

public void setNoUpdateNotebook(boolean noUpdateNotebook)

unsetNoUpdateNotebook

public void unsetNoUpdateNotebook()

isSetNoUpdateNotebook

public boolean isSetNoUpdateNotebook()

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

setNoUpdateNotebookIsSet

public void setNoUpdateNotebookIsSet(boolean value)

isNoExpungeNotebook

public boolean isNoExpungeNotebook()

setNoExpungeNotebook

public void setNoExpungeNotebook(boolean noExpungeNotebook)

unsetNoExpungeNotebook

public void unsetNoExpungeNotebook()

isSetNoExpungeNotebook

public boolean isSetNoExpungeNotebook()

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

setNoExpungeNotebookIsSet

public void setNoExpungeNotebookIsSet(boolean value)

isNoSetDefaultNotebook

public boolean isNoSetDefaultNotebook()

setNoSetDefaultNotebook

public void setNoSetDefaultNotebook(boolean noSetDefaultNotebook)

unsetNoSetDefaultNotebook

public void unsetNoSetDefaultNotebook()

isSetNoSetDefaultNotebook

public boolean isSetNoSetDefaultNotebook()

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

setNoSetDefaultNotebookIsSet

public void setNoSetDefaultNotebookIsSet(boolean value)

isNoSetNotebookStack

public boolean isNoSetNotebookStack()

setNoSetNotebookStack

public void setNoSetNotebookStack(boolean noSetNotebookStack)

unsetNoSetNotebookStack

public void unsetNoSetNotebookStack()

isSetNoSetNotebookStack

public boolean isSetNoSetNotebookStack()

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

setNoSetNotebookStackIsSet

public void setNoSetNotebookStackIsSet(boolean value)

isNoPublishToPublic

public boolean isNoPublishToPublic()

setNoPublishToPublic

public void setNoPublishToPublic(boolean noPublishToPublic)

unsetNoPublishToPublic

public void unsetNoPublishToPublic()

isSetNoPublishToPublic

public boolean isSetNoPublishToPublic()

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

setNoPublishToPublicIsSet

public void setNoPublishToPublicIsSet(boolean value)

isNoPublishToBusinessLibrary

public boolean isNoPublishToBusinessLibrary()

setNoPublishToBusinessLibrary

public void setNoPublishToBusinessLibrary(boolean noPublishToBusinessLibrary)

unsetNoPublishToBusinessLibrary

public void unsetNoPublishToBusinessLibrary()

isSetNoPublishToBusinessLibrary

public boolean isSetNoPublishToBusinessLibrary()

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

setNoPublishToBusinessLibraryIsSet

public void setNoPublishToBusinessLibraryIsSet(boolean value)

isNoCreateTags

public boolean isNoCreateTags()

setNoCreateTags

public void setNoCreateTags(boolean noCreateTags)

unsetNoCreateTags

public void unsetNoCreateTags()

isSetNoCreateTags

public boolean isSetNoCreateTags()

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

setNoCreateTagsIsSet

public void setNoCreateTagsIsSet(boolean value)

isNoUpdateTags

public boolean isNoUpdateTags()

setNoUpdateTags

public void setNoUpdateTags(boolean noUpdateTags)

unsetNoUpdateTags

public void unsetNoUpdateTags()

isSetNoUpdateTags

public boolean isSetNoUpdateTags()

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

setNoUpdateTagsIsSet

public void setNoUpdateTagsIsSet(boolean value)

isNoExpungeTags

public boolean isNoExpungeTags()

setNoExpungeTags

public void setNoExpungeTags(boolean noExpungeTags)

unsetNoExpungeTags

public void unsetNoExpungeTags()

isSetNoExpungeTags

public boolean isSetNoExpungeTags()

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

setNoExpungeTagsIsSet

public void setNoExpungeTagsIsSet(boolean value)

isNoSetParentTag

public boolean isNoSetParentTag()

setNoSetParentTag

public void setNoSetParentTag(boolean noSetParentTag)

unsetNoSetParentTag

public void unsetNoSetParentTag()

isSetNoSetParentTag

public boolean isSetNoSetParentTag()

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

setNoSetParentTagIsSet

public void setNoSetParentTagIsSet(boolean value)

isNoCreateSharedNotebooks

public boolean isNoCreateSharedNotebooks()

setNoCreateSharedNotebooks

public void setNoCreateSharedNotebooks(boolean noCreateSharedNotebooks)

unsetNoCreateSharedNotebooks

public void unsetNoCreateSharedNotebooks()

isSetNoCreateSharedNotebooks

public boolean isSetNoCreateSharedNotebooks()

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

setNoCreateSharedNotebooksIsSet

public void setNoCreateSharedNotebooksIsSet(boolean value)

getUpdateWhichSharedNotebookRestrictions

public SharedNotebookInstanceRestrictions getUpdateWhichSharedNotebookRestrictions()

See Also:

SharedNotebookInstanceRestrictions

setUpdateWhichSharedNotebookRestrictions

public void setUpdateWhichSharedNotebookRestrictions(SharedNotebookInstanceRestrictions updateWhichSharedNotebookRestrictions)

See Also:

SharedNotebookInstanceRestrictions

unsetUpdateWhichSharedNotebookRestrictions

public void unsetUpdateWhichSharedNotebookRestrictions()

isSetUpdateWhichSharedNotebookRestrictions

public boolean isSetUpdateWhichSharedNotebookRestrictions()

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

setUpdateWhichSharedNotebookRestrictionsIsSet

public void setUpdateWhichSharedNotebookRestrictionsIsSet(boolean value)

getExpungeWhichSharedNotebookRestrictions

public SharedNotebookInstanceRestrictions getExpungeWhichSharedNotebookRestrictions()

See Also:

SharedNotebookInstanceRestrictions

setExpungeWhichSharedNotebookRestrictions

public void setExpungeWhichSharedNotebookRestrictions(SharedNotebookInstanceRestrictions expungeWhichSharedNotebookRestrictions)

See Also:

SharedNotebookInstanceRestrictions

unsetExpungeWhichSharedNotebookRestrictions

public void unsetExpungeWhichSharedNotebookRestrictions()

isSetExpungeWhichSharedNotebookRestrictions

public boolean isSetExpungeWhichSharedNotebookRestrictions()

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

setExpungeWhichSharedNotebookRestrictionsIsSet

public void setExpungeWhichSharedNotebookRestrictionsIsSet(boolean value)

equals

public boolean equals(java.lang.Object that)

Overrides:

equals in class java.lang.Object

equals

public boolean equals(NotebookRestrictions that)

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

compareTo

public int compareTo(NotebookRestrictions other)

Specified by:

compareTo in interface java.lang.Comparable<NotebookRestrictions>

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

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

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