com.google.gdata.data.docs

Class ArchiveEntry

java.lang.Object

com.google.gdata.data.AbstractExtension

com.google.gdata.data.ExtensionPoint

com.google.gdata.data.BaseEntry<ArchiveEntry>

com.google.gdata.data.docs.ArchiveEntry

All Implemented Interfaces:

Extension, IAtom, IEntry, Kind.Adaptable, Kind.Adaptor

public class ArchiveEntry
extends BaseEntry<ArchiveEntry>

Describes an Archive entry.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.gdata.data.BaseEntry

BaseEntry.AtomHandler, BaseEntry.EntryState

Nested classes/interfaces inherited from class com.google.gdata.data.ExtensionPoint

ExtensionPoint.CumulativeBlobHandler, ExtensionPoint.ExtensionHandler

Nested classes/interfaces inherited from class com.google.gdata.data.AbstractExtension

AbstractExtension.AttributesHandler

Field Summary

Fields

Modifier and Type	Field and Description
static Category	CATEGORY Archive kind category.
static java.lang.String	KIND Archive kind term value.

Fields inherited from class com.google.gdata.data.BaseEntry

state

Fields inherited from class com.google.gdata.data.ExtensionPoint

xmlBlob

Fields inherited from class com.google.gdata.data.AbstractExtension

localName, namespace

Constructor Summary

Constructors

Constructor and Description
ArchiveEntry() Default mutable constructor.
ArchiveEntry(BaseEntry<?> sourceEntry) Constructs a new instance by doing a shallow copy of data from an existing BaseEntry instance.

Method Summary

Methods

Modifier and Type	Method and Description
void	addArchiveConversion(ArchiveConversion archiveConversion) Adds a new archive conversion.
void	addArchiveFailure(ArchiveFailure archiveFailure) Adds a new archive failure.
void	addArchiveResourceId(ArchiveResourceId archiveResourceId) Adds a new archive resource id.
void	declareExtensions(ExtensionProfile extProfile) Declares the set of expected Extension types for an ExtensionPoint within the target extension profile.
ArchiveComplete	getArchiveComplete() Returns the archive complete.
java.util.List<ArchiveConversion>	getArchiveConversions() Returns the archive conversions.
java.util.List<ArchiveFailure>	getArchiveFailures() Returns the archive failures.
ArchiveNotify	getArchiveNotify() Returns the archive notify.
ArchiveNotifyStatus	getArchiveNotifyStatus() Returns the archive notify status.
java.util.List<ArchiveResourceId>	getArchiveResourceIds() Returns the archive resource ids.
ArchiveStatus	getArchiveStatus() Returns the archive status.
ArchiveTotal	getArchiveTotal() Returns the archive total.
ArchiveTotalComplete	getArchiveTotalComplete() Returns the archive total complete.
ArchiveTotalFailure	getArchiveTotalFailure() Returns the archive total failure.
QuotaBytesUsed	getQuotaBytesUsed() Returns the quota bytes used.
boolean	hasArchiveComplete() Returns whether it has the archive complete.
boolean	hasArchiveConversions() Returns whether it has the archive conversions.
boolean	hasArchiveFailures() Returns whether it has the archive failures.
boolean	hasArchiveNotify() Returns whether it has the archive notify.
boolean	hasArchiveNotifyStatus() Returns whether it has the archive notify status.
boolean	hasArchiveResourceIds() Returns whether it has the archive resource ids.
boolean	hasArchiveStatus() Returns whether it has the archive status.
boolean	hasArchiveTotal() Returns whether it has the archive total.
boolean	hasArchiveTotalComplete() Returns whether it has the archive total complete.
boolean	hasArchiveTotalFailure() Returns whether it has the archive total failure.
boolean	hasQuotaBytesUsed() Returns whether it has the quota bytes used.
void	setArchiveComplete(ArchiveComplete archiveComplete) Sets the archive complete.
void	setArchiveNotify(ArchiveNotify archiveNotify) Sets the archive notify.
void	setArchiveNotifyStatus(ArchiveNotifyStatus archiveNotifyStatus) Sets the archive notify status.
void	setArchiveStatus(ArchiveStatus archiveStatus) Sets the archive status.
void	setArchiveTotal(ArchiveTotal archiveTotal) Sets the archive total.
void	setArchiveTotalComplete(ArchiveTotalComplete archiveTotalComplete) Sets the archive total complete.
void	setArchiveTotalFailure(ArchiveTotalFailure archiveTotalFailure) Sets the archive total failure.
void	setQuotaBytesUsed(QuotaBytesUsed quotaBytesUsed) Sets the quota bytes used.
java.lang.String	toString()
protected void	validate() Checks the attributes to see if there are any problems.

Methods inherited from class com.google.gdata.data.BaseEntry

addAdaptor, addHtmlLink, addLink, addLink, delete, generate, generateAtom, generateRss, getAdaptedEntry, getAdaptor, getAdaptors, getAuthors, getCanEdit, getCategories, getContent, getContentHandlerInfo, getContributors, getEdited, getEditLink, getEtag, getHandler, getHtmlLink, getId, getKind, getLink, getLinks, getLinks, getMediaEditLink, getPlainTextContent, getPubControl, getPublished, getResumableEditMediaLink, getRights, getSelectedFields, getSelf, getSelfLink, getService, getSource, getSummary, getTextContent, getTitle, getUpdated, getVersionId, isDraft, parseAtom, parseAtom, parseAtom, readEntry, readEntry, removeLinks, removeLinks, setCanEdit, setContent, setContent, setDraft, setEdited, setEtag, setId, setKind, setPubControl, setPublished, setRights, setSelectedFields, setService, setSource, setSummary, setTitle, setUpdated, setVersionId, update, visitChildren

Methods inherited from class com.google.gdata.data.ExtensionPoint

addExtension, addExtension, addRepeatingExtension, addRepeatingExtension, checkRequiredExtensions, createExtensionInstance, generate, generateCumulativeXmlBlob, generateExtensions, generateStartElement, getExtension, getExtensionDescription, getExtensionHandler, getExtensions, getManifest, getRepeatingExtension, getRepeatingExtensions, getXmlBlob, hasExtension, hasRepeatingExtension, initializeArbitraryXml, parseCumulativeXmlBlob, removeExtension, removeExtension, removeRepeatingExtension, setExtension, setXmlBlob, visit, visitChild

Methods inherited from class com.google.gdata.data.AbstractExtension

consumeAttributes, disableStrictValidation, enableStrictValidation, eq, generateAttributes, getExtensionLocalName, getExtensionNamespace, isImmutable, isStrictValidation, putAttributes, sameClassAs, setImmutable, throwExceptionForMissingAttribute, throwExceptionIfImmutable

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

KIND

public static final java.lang.String KIND

Archive kind term value.

See Also:

Constant Field Values

CATEGORY

public static final Category CATEGORY

Archive kind category.

Constructor Detail

ArchiveEntry

public ArchiveEntry()

Default mutable constructor.

ArchiveEntry

public ArchiveEntry(BaseEntry<?> sourceEntry)

Constructs a new instance by doing a shallow copy of data from an existing BaseEntry instance.

Parameters:

sourceEntry - source entry

Method Detail

declareExtensions

public void declareExtensions(ExtensionProfile extProfile)

Description copied from class: ExtensionPoint

Declares the set of expected Extension types for an ExtensionPoint within the target extension profile. The base implementation does not declare any extensions, but can be overridden by specific types of ExtensionPoints that always contain a well-defined set of extensions.

Specified by:

declareExtensions in interface Kind.Adaptor

Overrides:

declareExtensions in class ExtensionPoint

Parameters:

extProfile - the ExtensionProfile to initialize.

See Also:

ExtensionProfile.addDeclarations(Kind.Adaptor)

getArchiveComplete

public ArchiveComplete getArchiveComplete()

Returns the archive complete.

Returns:

archive complete

setArchiveComplete

public void setArchiveComplete(ArchiveComplete archiveComplete)

Sets the archive complete.

Parameters:

archiveComplete - archive complete or null to reset

hasArchiveComplete

public boolean hasArchiveComplete()

Returns whether it has the archive complete.

Returns:

whether it has the archive complete

getArchiveConversions

public java.util.List<ArchiveConversion> getArchiveConversions()

Returns the archive conversions.

Returns:

archive conversions

addArchiveConversion

public void addArchiveConversion(ArchiveConversion archiveConversion)

Adds a new archive conversion.

Parameters:

archiveConversion - archive conversion

hasArchiveConversions

public boolean hasArchiveConversions()

Returns whether it has the archive conversions.

Returns:

whether it has the archive conversions

getArchiveFailures

public java.util.List<ArchiveFailure> getArchiveFailures()

Returns the archive failures.

Returns:

archive failures

addArchiveFailure

public void addArchiveFailure(ArchiveFailure archiveFailure)

Adds a new archive failure.

Parameters:

archiveFailure - archive failure

hasArchiveFailures

public boolean hasArchiveFailures()

Returns whether it has the archive failures.

Returns:

whether it has the archive failures

getArchiveNotify

public ArchiveNotify getArchiveNotify()

Returns the archive notify.

Returns:

archive notify

setArchiveNotify

public void setArchiveNotify(ArchiveNotify archiveNotify)

Sets the archive notify.

Parameters:

archiveNotify - archive notify or null to reset

hasArchiveNotify

public boolean hasArchiveNotify()

Returns whether it has the archive notify.

Returns:

whether it has the archive notify

getArchiveNotifyStatus

public ArchiveNotifyStatus getArchiveNotifyStatus()

Returns the archive notify status.

Returns:

archive notify status

setArchiveNotifyStatus

public void setArchiveNotifyStatus(ArchiveNotifyStatus archiveNotifyStatus)

Sets the archive notify status.

Parameters:

archiveNotifyStatus - archive notify status or null to reset

hasArchiveNotifyStatus

public boolean hasArchiveNotifyStatus()

Returns whether it has the archive notify status.

Returns:

whether it has the archive notify status

getArchiveResourceIds

public java.util.List<ArchiveResourceId> getArchiveResourceIds()

Returns the archive resource ids.

Returns:

archive resource ids

addArchiveResourceId

public void addArchiveResourceId(ArchiveResourceId archiveResourceId)

Adds a new archive resource id.

Parameters:

archiveResourceId - archive resource id

hasArchiveResourceIds

public boolean hasArchiveResourceIds()

Returns whether it has the archive resource ids.

Returns:

whether it has the archive resource ids

getArchiveStatus

public ArchiveStatus getArchiveStatus()

Returns the archive status.

Returns:

archive status

setArchiveStatus

public void setArchiveStatus(ArchiveStatus archiveStatus)

Sets the archive status.

Parameters:

archiveStatus - archive status or null to reset

hasArchiveStatus

public boolean hasArchiveStatus()

Returns whether it has the archive status.

Returns:

whether it has the archive status

getArchiveTotal

public ArchiveTotal getArchiveTotal()

Returns the archive total.

Returns:

archive total

setArchiveTotal

public void setArchiveTotal(ArchiveTotal archiveTotal)

Sets the archive total.

Parameters:

archiveTotal - archive total or null to reset

hasArchiveTotal

public boolean hasArchiveTotal()

Returns whether it has the archive total.

Returns:

whether it has the archive total

getArchiveTotalComplete

public ArchiveTotalComplete getArchiveTotalComplete()

Returns the archive total complete.

Returns:

archive total complete

setArchiveTotalComplete

public void setArchiveTotalComplete(ArchiveTotalComplete archiveTotalComplete)

Sets the archive total complete.

Parameters:

archiveTotalComplete - archive total complete or null to reset

hasArchiveTotalComplete

public boolean hasArchiveTotalComplete()

Returns whether it has the archive total complete.

Returns:

whether it has the archive total complete

getArchiveTotalFailure

public ArchiveTotalFailure getArchiveTotalFailure()

Returns the archive total failure.

Returns:

archive total failure

setArchiveTotalFailure

public void setArchiveTotalFailure(ArchiveTotalFailure archiveTotalFailure)

Sets the archive total failure.

Parameters:

archiveTotalFailure - archive total failure or null to reset

hasArchiveTotalFailure

public boolean hasArchiveTotalFailure()

Returns whether it has the archive total failure.

Returns:

whether it has the archive total failure

getQuotaBytesUsed

public QuotaBytesUsed getQuotaBytesUsed()

Returns the quota bytes used.

Returns:

quota bytes used

setQuotaBytesUsed

public void setQuotaBytesUsed(QuotaBytesUsed quotaBytesUsed)

Sets the quota bytes used.

Parameters:

quotaBytesUsed - quota bytes used or null to reset

hasQuotaBytesUsed

public boolean hasQuotaBytesUsed()

Returns whether it has the quota bytes used.

Returns:

whether it has the quota bytes used

validate

protected void validate()

Description copied from class: AbstractExtension

Checks the attributes to see if there are any problems. Default implementation does nothing, though generally this is discouraged unless there really are no restrictions.

Overrides:

validate in class AbstractExtension

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object