com.evernote.edam.type
Class LinkedNotebook

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

All Implemented Interfaces:

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

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

A link in an users account that refers them to a public or individual share in another user's account.

shareName

the display name of the shared notebook. The link owner can change this.

username

the username of the user who owns the shared or public notebook

shardId

the shard ID of the notebook if the notebook is not public

shareKey

the secret key that provides access to the shared notebook

uri

the identifier of the public notebook

guid

The unique identifier of this linked notebook. Will be set whenever a linked notebook is retrieved from the service, but may be null when a client is creating a linked notebook.
Length: EDAM_GUID_LEN_MIN - EDAM_GUID_LEN_MAX
Regex: EDAM_GUID_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.

noteStoreUrl

This field will contain the full URL that clients should use to make NoteStore requests to the server shard that contains that notebook's data. I.e. this is the URL that should be used to create the Thrift HTTP client transport to send messages to the NoteStore service for the account.

webApiUrlPrefix:

This field will contain the initial part of the URLs that should be used to make requests to Evernote's thin client "web API", which provide optimized operations for clients that aren't capable of manipulating the full contents of accounts via the full Thrift data model. Clients should concatenate the relative path for the various servlets onto the end of this string to construct the full URL, as documented on our developer web site.

stack

If this is set, then the notebook is visually contained within a stack of notebooks with this name. All notebooks in the same account with the same 'stack' field are considered to be in the same stack. Notebooks with no stack set are "top level" and not contained within a stack. The link owner can change this and this field is for the benefit of the link owner.

businessId

If set, this will be the unique identifier for the business that owns the notebook to which the linked notebook refers.

See Also:

Serialized Form

Constructor Summary

LinkedNotebook()

LinkedNotebook(LinkedNotebook 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(LinkedNotebook other)
LinkedNotebook	deepCopy() Creates a deep copy of the object.
boolean	equals(LinkedNotebook that)
boolean	equals(java.lang.Object that)
int	getBusinessId()
java.lang.String	getGuid()
java.lang.String	getNoteStoreUrl()
java.lang.String	getShardId()
java.lang.String	getShareKey()
java.lang.String	getShareName()
java.lang.String	getStack()
int	getUpdateSequenceNum()
java.lang.String	getUri()
java.lang.String	getUsername()
java.lang.String	getWebApiUrlPrefix()
int	hashCode()
boolean	isSetBusinessId() Returns true if field businessId 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	isSetNoteStoreUrl() Returns true if field noteStoreUrl is set (has been asigned a value) and false otherwise
boolean	isSetShardId() Returns true if field shardId is set (has been asigned a value) and false otherwise
boolean	isSetShareKey() Returns true if field shareKey is set (has been asigned a value) and false otherwise
boolean	isSetShareName() Returns true if field shareName is set (has been asigned a value) and false otherwise
boolean	isSetStack() Returns true if field stack 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
boolean	isSetUri() Returns true if field uri is set (has been asigned a value) and false otherwise
boolean	isSetUsername() Returns true if field username is set (has been asigned a value) and false otherwise
boolean	isSetWebApiUrlPrefix() Returns true if field webApiUrlPrefix 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	setBusinessId(int businessId)
void	setBusinessIdIsSet(boolean value)
void	setGuid(java.lang.String guid)
void	setGuidIsSet(boolean value)
void	setNoteStoreUrl(java.lang.String noteStoreUrl)
void	setNoteStoreUrlIsSet(boolean value)
void	setShardId(java.lang.String shardId)
void	setShardIdIsSet(boolean value)
void	setShareKey(java.lang.String shareKey)
void	setShareKeyIsSet(boolean value)
void	setShareName(java.lang.String shareName)
void	setShareNameIsSet(boolean value)
void	setStack(java.lang.String stack)
void	setStackIsSet(boolean value)
void	setUpdateSequenceNum(int updateSequenceNum)
void	setUpdateSequenceNumIsSet(boolean value)
void	setUri(java.lang.String uri)
void	setUriIsSet(boolean value)
void	setUsername(java.lang.String username)
void	setUsernameIsSet(boolean value)
void	setWebApiUrlPrefix(java.lang.String webApiUrlPrefix)
void	setWebApiUrlPrefixIsSet(boolean value)
java.lang.String	toString()
void	unsetBusinessId()
void	unsetGuid()
void	unsetNoteStoreUrl()
void	unsetShardId()
void	unsetShareKey()
void	unsetShareName()
void	unsetStack()
void	unsetUpdateSequenceNum()
void	unsetUri()
void	unsetUsername()
void	unsetWebApiUrlPrefix()
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

LinkedNotebook

public LinkedNotebook()

LinkedNotebook

public LinkedNotebook(LinkedNotebook other)

Performs a deep copy on other.

Method Detail

deepCopy

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

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

getShareName

public java.lang.String getShareName()

setShareName

public void setShareName(java.lang.String shareName)

unsetShareName

public void unsetShareName()

isSetShareName

public boolean isSetShareName()

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

setShareNameIsSet

public void setShareNameIsSet(boolean value)

getUsername

public java.lang.String getUsername()

setUsername

public void setUsername(java.lang.String username)

unsetUsername

public void unsetUsername()

isSetUsername

public boolean isSetUsername()

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

setUsernameIsSet

public void setUsernameIsSet(boolean value)

getShardId

public java.lang.String getShardId()

setShardId

public void setShardId(java.lang.String shardId)

unsetShardId

public void unsetShardId()

isSetShardId

public boolean isSetShardId()

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

setShardIdIsSet

public void setShardIdIsSet(boolean value)

getShareKey

public java.lang.String getShareKey()

setShareKey

public void setShareKey(java.lang.String shareKey)

unsetShareKey

public void unsetShareKey()

isSetShareKey

public boolean isSetShareKey()

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

setShareKeyIsSet

public void setShareKeyIsSet(boolean value)

getUri

public java.lang.String getUri()

setUri

public void setUri(java.lang.String uri)

unsetUri

public void unsetUri()

isSetUri

public boolean isSetUri()

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

setUriIsSet

public void setUriIsSet(boolean value)

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)

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)

getNoteStoreUrl

public java.lang.String getNoteStoreUrl()

setNoteStoreUrl

public void setNoteStoreUrl(java.lang.String noteStoreUrl)

unsetNoteStoreUrl

public void unsetNoteStoreUrl()

isSetNoteStoreUrl

public boolean isSetNoteStoreUrl()

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

setNoteStoreUrlIsSet

public void setNoteStoreUrlIsSet(boolean value)

getWebApiUrlPrefix

public java.lang.String getWebApiUrlPrefix()

setWebApiUrlPrefix

public void setWebApiUrlPrefix(java.lang.String webApiUrlPrefix)

unsetWebApiUrlPrefix

public void unsetWebApiUrlPrefix()

isSetWebApiUrlPrefix

public boolean isSetWebApiUrlPrefix()

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

setWebApiUrlPrefixIsSet

public void setWebApiUrlPrefixIsSet(boolean value)

getStack

public java.lang.String getStack()

setStack

public void setStack(java.lang.String stack)

unsetStack

public void unsetStack()

isSetStack

public boolean isSetStack()

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

setStackIsSet

public void setStackIsSet(boolean value)

getBusinessId

public int getBusinessId()

setBusinessId

public void setBusinessId(int businessId)

unsetBusinessId

public void unsetBusinessId()

isSetBusinessId

public boolean isSetBusinessId()

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

setBusinessIdIsSet

public void setBusinessIdIsSet(boolean value)

equals

public boolean equals(java.lang.Object that)

Overrides:

equals in class java.lang.Object

equals

public boolean equals(LinkedNotebook that)

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

compareTo

public int compareTo(LinkedNotebook other)

Specified by:

compareTo in interface java.lang.Comparable<LinkedNotebook>

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

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

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