com.evernote.edam.type
Class NotebookDescriptor

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

All Implemented Interfaces:

TBase<NotebookDescriptor>, Serializable, Cloneable, Comparable<NotebookDescriptor>

public class NotebookDescriptor
extends Object
implements TBase<NotebookDescriptor>, Serializable, Cloneable

A structure that describes a notebook or a user's relationship with a notebook. NotebookDescriptor is expected to remain a lighter-weight structure when compared to Notebook.

guid

The unique identifier of the notebook.

notebookDisplayName

A sequence of characters representing the name of the notebook.

contactName

The User.name value of the notebook's "contact".

hasSharedNotebook

Whether a SharedNotebook record exists between the calling user and this notebook.

joinedUserCount

The number of users who have joined this notebook.

See Also:

Serialized Form

Constructor Summary

NotebookDescriptor()

NotebookDescriptor(NotebookDescriptor 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(NotebookDescriptor other)
NotebookDescriptor	deepCopy() Creates a deep copy of the object.
boolean	equals(NotebookDescriptor that)
boolean	equals(Object that)
String	getContactName()
String	getGuid()
int	getJoinedUserCount()
String	getNotebookDisplayName()
int	hashCode()
boolean	isHasSharedNotebook()
boolean	isSetContactName() Returns true if field contactName 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	isSetHasSharedNotebook() Returns true if field hasSharedNotebook is set (has been asigned a value) and false otherwise
boolean	isSetJoinedUserCount() Returns true if field joinedUserCount is set (has been asigned a value) and false otherwise
boolean	isSetNotebookDisplayName() Returns true if field notebookDisplayName is set (has been asigned a value) and false otherwise
void	read(TProtocol iprot) Reads an instance of the object from the given protocol.
void	setContactName(String contactName)
void	setContactNameIsSet(boolean value)
void	setGuid(String guid)
void	setGuidIsSet(boolean value)
void	setHasSharedNotebook(boolean hasSharedNotebook)
void	setHasSharedNotebookIsSet(boolean value)
void	setJoinedUserCount(int joinedUserCount)
void	setJoinedUserCountIsSet(boolean value)
void	setNotebookDisplayName(String notebookDisplayName)
void	setNotebookDisplayNameIsSet(boolean value)
String	toString()
void	unsetContactName()
void	unsetGuid()
void	unsetHasSharedNotebook()
void	unsetJoinedUserCount()
void	unsetNotebookDisplayName()
void	validate()
void	write(TProtocol oprot) Writes the object to the given protocol.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

NotebookDescriptor

public NotebookDescriptor()

NotebookDescriptor

public NotebookDescriptor(NotebookDescriptor other)

Performs a deep copy on other.

Method Detail

deepCopy

public NotebookDescriptor deepCopy()

Description copied from interface: TBase

Creates a deep copy of the object.

Specified by:

deepCopy in interface TBase<NotebookDescriptor>

clear

public void clear()

Description copied from interface: TBase

Return to the state of having just been initialized, as though you had just called the default constructor.

Specified by:

clear in interface TBase<NotebookDescriptor>

getGuid

public String getGuid()

setGuid

public void setGuid(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)

getNotebookDisplayName

public String getNotebookDisplayName()

setNotebookDisplayName

public void setNotebookDisplayName(String notebookDisplayName)

unsetNotebookDisplayName

public void unsetNotebookDisplayName()

isSetNotebookDisplayName

public boolean isSetNotebookDisplayName()

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

setNotebookDisplayNameIsSet

public void setNotebookDisplayNameIsSet(boolean value)

getContactName

public String getContactName()

setContactName

public void setContactName(String contactName)

unsetContactName

public void unsetContactName()

isSetContactName

public boolean isSetContactName()

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

setContactNameIsSet

public void setContactNameIsSet(boolean value)

isHasSharedNotebook

public boolean isHasSharedNotebook()

setHasSharedNotebook

public void setHasSharedNotebook(boolean hasSharedNotebook)

unsetHasSharedNotebook

public void unsetHasSharedNotebook()

isSetHasSharedNotebook

public boolean isSetHasSharedNotebook()

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

setHasSharedNotebookIsSet

public void setHasSharedNotebookIsSet(boolean value)

getJoinedUserCount

public int getJoinedUserCount()

setJoinedUserCount

public void setJoinedUserCount(int joinedUserCount)

unsetJoinedUserCount

public void unsetJoinedUserCount()

isSetJoinedUserCount

public boolean isSetJoinedUserCount()

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

setJoinedUserCountIsSet

public void setJoinedUserCountIsSet(boolean value)

equals

public boolean equals(Object that)

Overrides:

equals in class Object

equals

public boolean equals(NotebookDescriptor that)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

compareTo

public int compareTo(NotebookDescriptor other)

Specified by:

compareTo in interface Comparable<NotebookDescriptor>

read

public void read(TProtocol iprot)
          throws TException

Description copied from interface: TBase

Reads an instance of the object from the given protocol.

Specified by:

read in interface TBase<NotebookDescriptor>

Parameters:

iprot - Input protocol

Throws:

TException

write

public void write(TProtocol oprot)
           throws TException

Description copied from interface: TBase

Writes the object to the given protocol.

Specified by:

write in interface TBase<NotebookDescriptor>

Parameters:

oprot - Output protocol

Throws:

TException

toString

public String toString()

Overrides:

toString in class Object

validate

public void validate()
              throws TException

Throws:

TException