|
|||||||||
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<E>
com.google.gdata.data.media.MediaEntry<DocumentListEntry>
com.google.gdata.data.docs.DocumentListEntry
public class DocumentListEntry
An entry representing a single document of any type within a
DocumentListFeed
.
Nested Class Summary | |
---|---|
static class |
DocumentListEntry.MediaType
Represents the MIME types supported by the doclist GData feed |
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 | |
---|---|
static Category |
CATEGORY
Category used to label entries which are of item type. |
static java.lang.String |
FOLDERS_NAMESPACE
|
static java.lang.String |
KIND
Kind category term used to label the entries which are of item type. |
static java.lang.String |
LABEL
Label for category. |
static java.lang.String |
PARENT_NAMESPACE
|
static java.lang.String |
REVISIONS_NAMESPACE
|
static java.lang.String |
THUMBNAIL_NAMESPACE
|
static Category |
UNKNOWN_CATEGORY
Deprecated. Use CATEGORY instead. |
static java.lang.String |
UNKNOWN_KIND
Deprecated. Use KIND instead. |
static java.lang.String |
UNKNOWN_LABEL
Deprecated. Use LABEL instead. |
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 | |
---|---|
DocumentListEntry()
Constructs a new uninitialized entry, to be populated by the GData parsers. |
|
DocumentListEntry(BaseEntry<?> sourceEntry)
Constructs a new entry by doing a shallow copy from another BaseEntry instance. |
Method Summary | |
---|---|
void |
addFolder(Person owner,
java.lang.String folderName)
Deprecated. use BaseEntry.addLink(Link) with link relation PARENT_NAMESPACE
instead. |
void |
declareExtensions(ExtensionProfile extProfile)
Declares the set of expected Extension types for an ExtensionPoint within the target extension profile. |
AclFeed |
getAclFeed()
|
DocumentListAclFeedLink |
getAclFeedLink()
|
java.lang.String |
getDescription()
Returns the description of this document. |
java.lang.String |
getDocId()
Gets the docId or spreadsheet key from the resource id. |
Link |
getDocumentLink()
Gets the link with which you can open up the document in a Web browser. |
java.util.Set<java.lang.String> |
getFolders()
Deprecated. use getParentLinks() instead. |
java.lang.String |
getKey()
Deprecated. use getResourceId() instead. |
LastModifiedBy |
getLastModifiedBy()
Returns the user who last modified the document. |
DateTime |
getLastViewed()
Returns the time when the document was last viewed by the user. |
java.lang.String |
getMd5Checksum()
Returns the MD5 checksum calculated for the document. |
protected static java.lang.String |
getMimeTypeFromFileName(java.lang.String fileName)
Returns the mime type given a file name. |
java.util.List<Link> |
getParentLinks()
|
java.lang.Long |
getQuotaBytesUsed()
Returns the amount of quota consumed by the document. |
java.lang.String |
getResourceId()
Returns the document's resource id. |
java.lang.String |
getType()
Returns the type document entry from the resource id. |
boolean |
isHidden()
|
boolean |
isStarred()
|
boolean |
isTrashed()
|
boolean |
isViewed()
|
java.lang.Boolean |
isWritersCanInvite()
Returns a flag for whether writers can invite other collaborators |
void |
setDescription(java.lang.String description)
Sets the description of this document. |
void |
setFile(java.io.File file)
Deprecated. use setFile(File, String) instead. |
void |
setFile(java.io.File file,
java.lang.String mimeType)
Associate a File with this entry with the specified mime type |
void |
setHidden(boolean hidden)
Sets the hidden status of this document for the user this feed request has been authenticated under. |
void |
setLastModifiedBy(LastModifiedBy lastModifiedBy)
Sets the amount of quota consumed by the document. |
void |
setLastViewed(DateTime lastViewed)
Sets the time when the document was last viewed by the user. |
void |
setMd5Checksum(java.lang.String md5Checksum)
Set the MD5 checksum calculated for the document. |
void |
setQuotaBytesUsed(java.lang.Long quotaBytesUsed)
Sets the amount of quota consumed by the document. |
void |
setResourceId(java.lang.String resourceId)
Sets the document's resource id. |
void |
setStarred(boolean starred)
Sets the starred status of this document for the user this feed request has been authenticated under. |
void |
setTrashed(boolean trashed)
Sets the trashed status of this document for the user this feed request has been authenticated under. |
void |
setViewed(boolean viewed)
Sets the viewed status of this document for the user this feed request has been authenticated under. |
void |
setWritersCanInvite(java.lang.Boolean writersCanInvite)
Sets whether users classed as writers can invite other collaborators |
Methods inherited from class com.google.gdata.data.media.MediaEntry |
---|
getContentHandlerInfo, getMediaEditLink, getMediaSource, setMediaSource, setService, updateMedia |
Methods inherited from class com.google.gdata.data.BaseEntry |
---|
addAdaptor, addHtmlLink, addLink, addLink, delete, generate, generateAtom, generateRss, getAdaptedEntry, getAdaptor, getAdaptors, getAuthors, getCanEdit, getCategories, getContent, getContributors, getEdited, getEditLink, getEtag, getHandler, getHtmlLink, getId, getKind, getLink, getLinks, getLinks, 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, 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, validate |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface com.google.gdata.data.IEntry |
---|
getCanEdit, getContent, getEdited, getEditLink, getPublished, getResumableEditMediaLink, getSelectedFields, getSummary, setCanEdit, setEdited, setPublished, setSelectedFields |
Methods inherited from interface com.google.gdata.data.IAtom |
---|
addLink, getAuthors, getCategories, getEtag, getId, getKind, getLink, getLinks, getSelfLink, getTitle, getUpdated, getVersionId, removeLinks, removeLinks, setEtag, setId, setKind, setUpdated, setVersionId |
Field Detail |
---|
@Deprecated public static final java.lang.String UNKNOWN_LABEL
@Deprecated public static final java.lang.String UNKNOWN_KIND
@Deprecated public static final Category UNKNOWN_CATEGORY
public static final java.lang.String LABEL
public static final java.lang.String KIND
public static final Category CATEGORY
public static final java.lang.String FOLDERS_NAMESPACE
public static final java.lang.String PARENT_NAMESPACE
public static final java.lang.String REVISIONS_NAMESPACE
public static final java.lang.String THUMBNAIL_NAMESPACE
Constructor Detail |
---|
public DocumentListEntry()
public DocumentListEntry(BaseEntry<?> sourceEntry)
Method Detail |
---|
protected static java.lang.String getMimeTypeFromFileName(java.lang.String fileName)
java.lang.IllegalArgumentException
- if the mime type is not known
given the file namepublic void declareExtensions(ExtensionProfile extProfile)
ExtensionPoint
declareExtensions
in interface Kind.Adaptor
declareExtensions
in class ExtensionPoint
extProfile
- the ExtensionProfile to initialize.ExtensionProfile.addDeclarations(Kind.Adaptor)
public Link getDocumentLink()
@Deprecated public java.lang.String getKey()
http://docs.google.com/getdoc?id={id}
http://spreadsheets.google.com/ccc?key={id}
public java.lang.String getDocId()
http://docs.google.com/present/edit?id={id}
http://spreadsheets.google.com/ccc?key={id}
public java.lang.String getType()
@Deprecated public void setFile(java.io.File file)
public void setFile(java.io.File file, java.lang.String mimeType)
public void setHidden(boolean hidden)
hidden
- true if the document should be hiddenpublic boolean isHidden()
public void setStarred(boolean starred)
starred
- true if the document should be starredpublic boolean isStarred()
public void setViewed(boolean viewed)
viewed
- true if the document has been viewedpublic boolean isViewed()
public void setTrashed(boolean trashed)
trashed
- true if the document should be trashedpublic boolean isTrashed()
@Deprecated public void addFolder(Person owner, java.lang.String folderName)
BaseEntry.addLink(Link)
with link relation PARENT_NAMESPACE
instead.
owner
- the owner of the folderfolderName
- the name of the folder@Deprecated public java.util.Set<java.lang.String> getFolders()
getParentLinks()
instead.
public DocumentListAclFeedLink getAclFeedLink()
public AclFeed getAclFeed()
public java.util.List<Link> getParentLinks()
public java.lang.String getDescription()
null
means no description was set, whereas the empty-string
means the description is empty)public void setDescription(java.lang.String description)
description
- the descriptionpublic DateTime getLastViewed()
public void setLastViewed(DateTime lastViewed)
lastViewed
- the last viewed timepublic java.lang.String getMd5Checksum()
public void setMd5Checksum(java.lang.String md5Checksum)
md5Checksum
- the MD5 checksumpublic java.lang.Long getQuotaBytesUsed()
public void setQuotaBytesUsed(java.lang.Long quotaBytesUsed)
quotaBytesUsed
- the quota usedpublic java.lang.Boolean isWritersCanInvite()
public void setWritersCanInvite(java.lang.Boolean writersCanInvite)
writersCanInvite
- true if writers can invitepublic LastModifiedBy getLastModifiedBy()
public void setLastModifiedBy(LastModifiedBy lastModifiedBy)
lastModifiedBy
- the quota usedpublic java.lang.String getResourceId()
public void setResourceId(java.lang.String resourceId)
resourceId
- the resource id.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |