|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.google.gdata.data.AbstractExtension
com.google.gdata.data.ExtensionPoint
com.google.gdata.data.BaseEntry<DocumentExportEntry>
com.google.gdata.data.docs.DocumentExportEntry
public class DocumentExportEntry
Describes an entry representing a request to bulk export documents from a user.
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 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 | |
---|---|
DocumentExportEntry()
Default mutable constructor. |
|
DocumentExportEntry(BaseEntry<?> sourceEntry)
Constructs a new instance by doing a shallow copy of data from an existing BaseEntry instance. |
Method Summary | |
---|---|
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. |
java.util.List<ExportDocId> |
getExportDocIds()
Returns the export doc ids. |
DocumentExportRequestor |
getExportRequestor()
Returns the document export requestor. |
ObjectNumber |
getObjectNumber()
Returns the object number. |
java.util.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. |
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.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 |
Constructor Detail |
---|
public DocumentExportEntry()
public DocumentExportEntry(BaseEntry<?> sourceEntry)
BaseEntry
instance.
sourceEntry
- source entryMethod Detail |
---|
public void declareExtensions(ExtensionProfile extProfile)
ExtensionPoint
declareExtensions
in interface Kind.Adaptor
declareExtensions
in class ExtensionPoint
extProfile
- the ExtensionProfile to initialize.ExtensionProfile.addDeclarations(Kind.Adaptor)
public java.util.List<ExportDocId> getExportDocIds()
public void addExportDocId(ExportDocId exportDocId)
exportDocId
- export doc idpublic boolean hasExportDocIds()
public DocumentExportRequestor getExportRequestor()
public void setExportRequestor(DocumentExportRequestor exportRequestor)
exportRequestor
- document export requestor or null
to
resetpublic boolean hasExportRequestor()
public ObjectNumber getObjectNumber()
public void setObjectNumber(ObjectNumber objectNumber)
objectNumber
- object number or null
to resetpublic boolean hasObjectNumber()
public java.util.List<QueryParameter> getQueries()
public void addQuery(QueryParameter query)
query
- query parameterpublic boolean hasQueries()
public ExportStatus getStatus()
public void setStatus(ExportStatus status)
status
- export status or null
to resetpublic boolean hasStatus()
public Link getDocumentExportLink()
null
for none.protected void validate()
AbstractExtension
validate
in class AbstractExtension
public java.lang.String toString()
toString
in class java.lang.Object
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |