public class

ArchiveEntry

extends BaseEntry<E extends BaseEntry>
java.lang.Object
   ↳ com.google.gdata.data.AbstractExtension
     ↳ com.google.gdata.data.ExtensionPoint
       ↳ com.google.gdata.data.BaseEntry<E extends com.google.gdata.data.BaseEntry>
         ↳ com.google.gdata.data.docs.ArchiveEntry

Class Overview

Describes an Archive entry.

Summary

Constants
String KIND Archive kind term value.
Fields
public static final Category CATEGORY Archive kind category.
[Expand]
Inherited Fields
From class com.google.gdata.data.BaseEntry
From class com.google.gdata.data.ExtensionPoint
From class com.google.gdata.data.AbstractExtension
Public Constructors
ArchiveEntry()
Default mutable constructor.
ArchiveEntry(BaseEntry<?> sourceEntry)
Constructs a new instance by doing a shallow copy of data from an existing BaseEntry instance.
Public Methods
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.
List<ArchiveConversion> getArchiveConversions()
Returns the archive conversions.
List<ArchiveFailure> getArchiveFailures()
Returns the archive failures.
ArchiveNotify getArchiveNotify()
Returns the archive notify.
ArchiveNotifyStatus getArchiveNotifyStatus()
Returns the archive notify status.
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.
String toString()
Protected Methods
void validate()
Checks the attributes to see if there are any problems.
[Expand]
Inherited Methods
From class com.google.gdata.data.BaseEntry
From class com.google.gdata.data.ExtensionPoint
From class com.google.gdata.data.AbstractExtension
From class java.lang.Object
From interface com.google.gdata.data.Extension
From interface com.google.gdata.data.IAtom
From interface com.google.gdata.data.IEntry
From interface com.google.gdata.data.Kind.Adaptable
From interface com.google.gdata.data.Kind.Adaptor

Constants

public static final String KIND

Archive kind term value.

Constant Value: "http://schemas.google.com/docs/2007#archive"

Fields

public static final Category CATEGORY

Archive kind category.

Public Constructors

public ArchiveEntry ()

Default mutable constructor.

public ArchiveEntry (BaseEntry<?> sourceEntry)

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

Parameters
sourceEntry Source entry

Public Methods

public void addArchiveConversion (ArchiveConversion archiveConversion)

Adds a new archive conversion.

Parameters
archiveConversion Archive conversion

public void addArchiveFailure (ArchiveFailure archiveFailure)

Adds a new archive failure.

Parameters
archiveFailure Archive failure

public void addArchiveResourceId (ArchiveResourceId archiveResourceId)

Adds a new archive resource id.

Parameters
archiveResourceId Archive resource id

public void declareExtensions (ExtensionProfile extProfile)

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.

Parameters
extProfile The ExtensionProfile to initialize.

public ArchiveComplete getArchiveComplete ()

Returns the archive complete.

Returns
  • archive complete

public List<ArchiveConversion> getArchiveConversions ()

Returns the archive conversions.

Returns
  • archive conversions

public List<ArchiveFailure> getArchiveFailures ()

Returns the archive failures.

Returns
  • archive failures

public ArchiveNotify getArchiveNotify ()

Returns the archive notify.

Returns
  • archive notify

public ArchiveNotifyStatus getArchiveNotifyStatus ()

Returns the archive notify status.

Returns
  • archive notify status

public List<ArchiveResourceId> getArchiveResourceIds ()

Returns the archive resource ids.

Returns
  • archive resource ids

public ArchiveStatus getArchiveStatus ()

Returns the archive status.

Returns
  • archive status

public ArchiveTotal getArchiveTotal ()

Returns the archive total.

Returns
  • archive total

public ArchiveTotalComplete getArchiveTotalComplete ()

Returns the archive total complete.

Returns
  • archive total complete

public ArchiveTotalFailure getArchiveTotalFailure ()

Returns the archive total failure.

Returns
  • archive total failure

public QuotaBytesUsed getQuotaBytesUsed ()

Returns the quota bytes used.

Returns
  • quota bytes used

public boolean hasArchiveComplete ()

Returns whether it has the archive complete.

Returns
  • whether it has the archive complete

public boolean hasArchiveConversions ()

Returns whether it has the archive conversions.

Returns
  • whether it has the archive conversions

public boolean hasArchiveFailures ()

Returns whether it has the archive failures.

Returns
  • whether it has the archive failures

public boolean hasArchiveNotify ()

Returns whether it has the archive notify.

Returns
  • whether it has the archive notify

public boolean hasArchiveNotifyStatus ()

Returns whether it has the archive notify status.

Returns
  • whether it has the archive notify status

public boolean hasArchiveResourceIds ()

Returns whether it has the archive resource ids.

Returns
  • whether it has the archive resource ids

public boolean hasArchiveStatus ()

Returns whether it has the archive status.

Returns
  • whether it has the archive status

public boolean hasArchiveTotal ()

Returns whether it has the archive total.

Returns
  • whether it has the archive total

public boolean hasArchiveTotalComplete ()

Returns whether it has the archive total complete.

Returns
  • whether it has the archive total complete

public boolean hasArchiveTotalFailure ()

Returns whether it has the archive total failure.

Returns
  • whether it has the archive total failure

public boolean hasQuotaBytesUsed ()

Returns whether it has the quota bytes used.

Returns
  • whether it has the quota bytes used

public void setArchiveComplete (ArchiveComplete archiveComplete)

Sets the archive complete.

Parameters
archiveComplete Archive complete or null to reset

public void setArchiveNotify (ArchiveNotify archiveNotify)

Sets the archive notify.

Parameters
archiveNotify Archive notify or null to reset

public void setArchiveNotifyStatus (ArchiveNotifyStatus archiveNotifyStatus)

Sets the archive notify status.

Parameters
archiveNotifyStatus Archive notify status or null to reset

public void setArchiveStatus (ArchiveStatus archiveStatus)

Sets the archive status.

Parameters
archiveStatus Archive status or null to reset

public void setArchiveTotal (ArchiveTotal archiveTotal)

Sets the archive total.

Parameters
archiveTotal Archive total or null to reset

public void setArchiveTotalComplete (ArchiveTotalComplete archiveTotalComplete)

Sets the archive total complete.

Parameters
archiveTotalComplete Archive total complete or null to reset

public void setArchiveTotalFailure (ArchiveTotalFailure archiveTotalFailure)

Sets the archive total failure.

Parameters
archiveTotalFailure Archive total failure or null to reset

public void setQuotaBytesUsed (QuotaBytesUsed quotaBytesUsed)

Sets the quota bytes used.

Parameters
quotaBytesUsed Quota bytes used or null to reset

public String toString ()

Protected Methods

protected void validate ()

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.