public class

DocumentExportEntry

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.DocumentExportEntry

Class Overview

Describes an entry representing a request to bulk export documents from a user.

Summary

[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
DocumentExportEntry()
Default mutable constructor.
DocumentExportEntry(BaseEntry<?> sourceEntry)
Constructs a new instance by doing a shallow copy of data from an existing BaseEntry instance.
Public Methods
void addExportDocId(ExportDocId exportDocId)
Adds a new export doc id.
void addQuery(QueryParameter query)
Adds a new query parameter.
void declareExtensions(ExtensionProfile extProfile)
Declares the set of expected Extension types for an ExtensionPoint within the target extension profile.
Link getDocumentExportLink()
Returns the link for the zip file contains all exported documents.
List<ExportDocId> getExportDocIds()
Returns the export doc ids.
DocumentExportRequestor getExportRequestor()
Returns the document export requestor.
ObjectNumber getObjectNumber()
Returns the object number.
List<QueryParameter> getQueries()
Returns the query parameters.
ExportStatus getStatus()
Returns the export status.
boolean hasExportDocIds()
Returns whether it has the export doc ids.
boolean hasExportRequestor()
Returns whether it has the document export requestor.
boolean hasObjectNumber()
Returns whether it has the object number.
boolean hasQueries()
Returns whether it has the query parameters.
boolean hasStatus()
Returns whether it has the export status.
void setExportRequestor(DocumentExportRequestor exportRequestor)
Sets the document export requestor.
void setObjectNumber(ObjectNumber objectNumber)
Sets the object number.
void setStatus(ExportStatus status)
Sets the export status.
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

Public Constructors

public DocumentExportEntry ()

Default mutable constructor.

public DocumentExportEntry (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 addExportDocId (ExportDocId exportDocId)

Adds a new export doc id.

Parameters
exportDocId Export doc id

public void addQuery (QueryParameter query)

Adds a new query parameter.

Parameters
query Query parameter

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 Link getDocumentExportLink ()

Returns the link for the zip file contains all exported documents.

Returns
  • Link for the zip file contains all exported documents or null for none.

public List<ExportDocId> getExportDocIds ()

Returns the export doc ids.

Returns
  • export doc ids

public DocumentExportRequestor getExportRequestor ()

Returns the document export requestor.

Returns
  • document export requestor

public ObjectNumber getObjectNumber ()

Returns the object number.

Returns
  • object number

public List<QueryParameter> getQueries ()

Returns the query parameters.

Returns
  • query parameters

public ExportStatus getStatus ()

Returns the export status.

Returns
  • export status

public boolean hasExportDocIds ()

Returns whether it has the export doc ids.

Returns
  • whether it has the export doc ids

public boolean hasExportRequestor ()

Returns whether it has the document export requestor.

Returns
  • whether it has the document export requestor

public boolean hasObjectNumber ()

Returns whether it has the object number.

Returns
  • whether it has the object number

public boolean hasQueries ()

Returns whether it has the query parameters.

Returns
  • whether it has the query parameters

public boolean hasStatus ()

Returns whether it has the export status.

Returns
  • whether it has the export status

public void setExportRequestor (DocumentExportRequestor exportRequestor)

Sets the document export requestor.

Parameters
exportRequestor Document export requestor or null to reset

public void setObjectNumber (ObjectNumber objectNumber)

Sets the object number.

Parameters
objectNumber Object number or null to reset

public void setStatus (ExportStatus status)

Sets the export status.

Parameters
status Export status 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.