com.google.gdata.data
Interface IEntry

All Known Implementing Classes:
AclEntry, AlbumEntry, AttendeeEntry, BaseEntry, BaseEventEntry, BaseHealthEntry, BlogEntry, CalendarAclEntry, CalendarEntry, CalendarEventEntry, CellEntry, CodeSearchEntry, CollectionEntry, CommentEntry, CommentEntry, CommentEntry, ComplaintEntry, ContactEntry, ContactEntry, ContactGroupEntry, CrawlIssueEntry, DocumentEntry, DocumentListEntry, EmailListEntry, EmailListRecipientEntry, Entry, EventEntry, FeedLinkEntry, FolderEntry, FriendEntry, GenericEntry, GoogleBaseEntry, GoogleBaseMediaEntry, GphotoEntry, KeywordEntry, ListEntry, MailItemEntry, MediaEntry, MessageEntry, MessageEntry, NicknameEntry, PdfEntry, PhotoEntry, PhotoEntry, PlaylistEntry, PlaylistLinkEntry, PortfolioEntry, PositionEntry, PostEntry, PresentationEntry, ProfileEntry, RatingEntry, RegisterEntry, SitemapsEntry, SitemapsMobileEntry, SitemapsNewsEntry, SitemapsRegularEntry, SitesEntry, SpreadsheetEntry, SpreadsheetEntry, SubscriptionEntry, TagEntry, TransactionEntry, UserEntry, UserEntry, UserProfileEntry, VideoEntry, VideoMessageEntry, VolumeEntry, WorksheetEntry

public interface IEntry

Shared interface for model and data BaseEntry to implement.


Method Summary
 ILink addLink(java.lang.String rel, java.lang.String type, java.lang.String href)
          Creates and adds a link to the entry.
 java.util.List<? extends IPerson> getAuthors()
          Gets a list of all authors on this entry.
 boolean getCanEdit()
          Returns true if the entry can be modified by a client.
 java.util.Set<? extends ICategory> getCategories()
          Gets a set of all categories on this entry.
 IContent getContent()
          Gets the content of this entry.
 DateTime getEdited()
          Get a DateTime instance representing the last time this entry was edited.
 ILink getEditLink()
          Gets the edit link, which is the link to PUT an updated version of the entry to.
 java.lang.String getEtag()
          Gets the value of the gd:etag attribute for this entry.
 java.lang.String getId()
          Get the unique id for this entry.
 ILink getLink(java.lang.String rel, java.lang.String type)
          Retrieves the first link with the supplied rel and/or type value.
 java.util.List<? extends ILink> getLinks()
          Gets a list containing all links on this entry.
 ILink getMediaEditLink()
          Gets the media-edit link, which is the link to PUT an updated version of the media content to.
 DateTime getPublished()
          Get a DateTime instance representing the time that this entry was created.
 ILink getSelfLink()
          Gets the self link, which points back at this entry.
 DateTime getUpdated()
          Get a DateTime instance representing the last time this entry was updated.
 java.lang.String getVersionId()
          Version ID.
 void setCanEdit(boolean canEdit)
          Sets whether the server allows this entry to be modified by the client.
 void setEdited(DateTime edited)
          Set the last time this entry was edited using the app:edited element.
 void setEtag(java.lang.String etag)
          Sets the value of the gd:etag attribute for this entry.
 void setId(java.lang.String id)
          Sets the unique id for this entry.
 void setPublished(DateTime published)
          Sets the date of publishing for this entry.
 void setService(Service s)
          Sets the service that this entry is being used with.
 void setUpdated(DateTime updated)
          Sets the last time this entry was updated.
 void setVersionId(java.lang.String versionId)
          Sets the versionId.
 

Method Detail

getId

java.lang.String getId()
Get the unique id for this entry. Represents the atom:id element.


setId

void setId(java.lang.String id)
Sets the unique id for this entry.


getVersionId

java.lang.String getVersionId()
Version ID. This is a unique number representing this particular entry. Every update changes the version ID (unless the update doesn't modify anything, in which case it's permissible for version ID to stay the same). Services are free to interpret this string in the most convenient way. Some services may choose to use a monotonically increasing sequence of version IDs. Other services may compute a hash of entry properties and use that.

This property is only used for services to communicate the current version ID back to the servlet. It is NOT set when entries are parsed (either from requests or from arbitrary XML).


setVersionId

void setVersionId(java.lang.String versionId)
Sets the versionId. See getVersionId() for a description of what the versionId is used for.


getUpdated

DateTime getUpdated()
Get a DateTime instance representing the last time this entry was updated. Represents the atom:updated element.


setUpdated

void setUpdated(DateTime updated)
Sets the last time this entry was updated.


getEdited

DateTime getEdited()
Get a DateTime instance representing the last time this entry was edited. Represents the app:edited element.


setEdited

void setEdited(DateTime edited)
Set the last time this entry was edited using the app:edited element.


getPublished

DateTime getPublished()
Get a DateTime instance representing the time that this entry was created. Represents the atom:published element.


setPublished

void setPublished(DateTime published)
Sets the date of publishing for this entry. Used on the server to specify when the entry was created.


getEtag

java.lang.String getEtag()
Gets the value of the gd:etag attribute for this entry. See RFC 2616, Section 3.11.


setEtag

void setEtag(java.lang.String etag)
Sets the value of the gd:etag attribute for this entry.


getCanEdit

boolean getCanEdit()
Returns true if the entry can be modified by a client.


setCanEdit

void setCanEdit(boolean canEdit)
Sets whether the server allows this entry to be modified by the client.


getContent

IContent getContent()
Gets the content of this entry. Represents the atom:content element.


setService

void setService(Service s)
Sets the service that this entry is being used with.


getSelfLink

ILink getSelfLink()
Gets the self link, which points back at this entry. Useful for retrieving the latest version of an entry. Will return null if no self link is available.


getEditLink

ILink getEditLink()
Gets the edit link, which is the link to PUT an updated version of the entry to. Will return null if no edit link is available.


getMediaEditLink

ILink getMediaEditLink()
Gets the media-edit link, which is the link to PUT an updated version of the media content to. Will return null if the media-edit link does not exist.


getLink

ILink getLink(java.lang.String rel,
              java.lang.String type)
Retrieves the first link with the supplied rel and/or type value.

If either parameter is null, it will not return matches for that paramter.

Parameters:
rel - link relation.
type - link type.
Returns:
first matching link.

getLinks

java.util.List<? extends ILink> getLinks()
Gets a list containing all links on this entry.


addLink

ILink addLink(java.lang.String rel,
              java.lang.String type,
              java.lang.String href)
Creates and adds a link to the entry.

Parameters:
rel - the value of the "rel" attribute on the link
type - the value of the "type" attribute on the link
href - the value of the "href" attribute on the link
Returns:
the link that was created

getAuthors

java.util.List<? extends IPerson> getAuthors()
Gets a list of all authors on this entry.

Returns:
a list of authors for the entry.

getCategories

java.util.Set<? extends ICategory> getCategories()
Gets a set of all categories on this entry.

Returns:
a set of categories for the entry.