com.evernote.edam.type
Class Publishing

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

All Implemented Interfaces:

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

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

If a Notebook has been opened to the public, the Notebook will have a reference to one of these structures, which gives the location and optional description of the externally-visible public Notebook.

uri

If this field is present, then the notebook is published for mass consumption on the Internet under the provided URI, which is relative to a defined base publishing URI defined by the service. This field can only be modified via the web service GUI ... publishing cannot be modified via an offline client.
Length: EDAM_PUBLISHING_URI_LEN_MIN - EDAM_PUBLISHING_URI_LEN_MAX
Regex: EDAM_PUBLISHING_URI_REGEX

order

When the notes are publicly displayed, they will be sorted based on the requested criteria.

ascending

If this is set to true, then the public notes will be displayed in ascending order (e.g. from oldest to newest). Otherwise, the notes will be displayed in descending order (e.g. newest to oldest).

publicDescription

This field may be used to provide a short description of the notebook, which may be displayed when (e.g.) the notebook is shown in a public view. Can't begin or end with a space.
Length: EDAM_PUBLISHING_DESCRIPTION_LEN_MIN - EDAM_PUBLISHING_DESCRIPTION_LEN_MAX
Regex: EDAM_PUBLISHING_DESCRIPTION_REGEX

See Also:

Serialized Form

Constructor Summary

Publishing()

Publishing(Publishing 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(Publishing other)
Publishing	deepCopy() Creates a deep copy of the object.
boolean	equals(java.lang.Object that)
boolean	equals(Publishing that)
NoteSortOrder	getOrder()
java.lang.String	getPublicDescription()
java.lang.String	getUri()
int	hashCode()
boolean	isAscending()
boolean	isSetAscending() Returns true if field ascending is set (has been asigned a value) and false otherwise
boolean	isSetOrder() Returns true if field order is set (has been asigned a value) and false otherwise
boolean	isSetPublicDescription() Returns true if field publicDescription 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
void	read(com.evernote.thrift.protocol.TProtocol iprot) Reads an instance of the object from the given protocol.
void	setAscending(boolean ascending)
void	setAscendingIsSet(boolean value)
void	setOrder(NoteSortOrder order)
void	setOrderIsSet(boolean value)
void	setPublicDescription(java.lang.String publicDescription)
void	setPublicDescriptionIsSet(boolean value)
void	setUri(java.lang.String uri)
void	setUriIsSet(boolean value)
java.lang.String	toString()
void	unsetAscending()
void	unsetOrder()
void	unsetPublicDescription()
void	unsetUri()
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

Publishing

public Publishing()

Publishing

public Publishing(Publishing other)

Performs a deep copy on other.

Method Detail

deepCopy

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

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

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)

getOrder

public NoteSortOrder getOrder()

See Also:

NoteSortOrder

setOrder

public void setOrder(NoteSortOrder order)

See Also:

NoteSortOrder

unsetOrder

public void unsetOrder()

isSetOrder

public boolean isSetOrder()

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

setOrderIsSet

public void setOrderIsSet(boolean value)

isAscending

public boolean isAscending()

setAscending

public void setAscending(boolean ascending)

unsetAscending

public void unsetAscending()

isSetAscending

public boolean isSetAscending()

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

setAscendingIsSet

public void setAscendingIsSet(boolean value)

getPublicDescription

public java.lang.String getPublicDescription()

setPublicDescription

public void setPublicDescription(java.lang.String publicDescription)

unsetPublicDescription

public void unsetPublicDescription()

isSetPublicDescription

public boolean isSetPublicDescription()

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

setPublicDescriptionIsSet

public void setPublicDescriptionIsSet(boolean value)

equals

public boolean equals(java.lang.Object that)

Overrides:

equals in class java.lang.Object

equals

public boolean equals(Publishing that)

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

compareTo

public int compareTo(Publishing other)

Specified by:

compareTo in interface java.lang.Comparable<Publishing>

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

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

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