Google Data APIs Client Library (1.38.0)
com.google.gdata.data
Interface IAtom
- All Known Subinterfaces:
- IEntry, IFeed, IMediaEntry
- All Known Implementing Classes:
- AccountEntry, AccountFeed, AclEntry, AclFeed, ActivityEntry, ActivityFeed, AlbumEntry, AlbumFeed, AnnouncementEntry, AnnouncementsPageEntry, AttachmentEntry, AttendeeEntry, AttendeeFeed, BaseActivityEntry, BaseContentEntry, BaseEntry, BaseEventEntry, BaseEventFeed, BaseFeed, BaseHealthEntry, BaseHealthFeed, BasePageEntry, BasePersonEntry, BlogCommentFeed, BlogEntry, BlogFeed, BlogPostFeed, CalendarAclEntry, CalendarEntry, CalendarEventEntry, CalendarEventFeed, CalendarFeed, CaptionTrackEntry, CaptionTrackFeed, CellEntry, CellFeed, ChannelEntry, ChannelFeed, CodeSearchEntry, CodeSearchFeed, CollectionEntry, CollectionFeed, CommentEntry, CommentEntry, CommentEntry, CommentEntry, CommentFeed, ComplaintEntry, ComplaintFeed, ContactEntry, ContactEntry, ContactFeed, ContactFeed, ContactGroupEntry, ContactGroupFeed, ContentEntry, ContentFeed, CrawlIssueEntry, CrawlIssuesFeed, CreationActivityEntry, DataEntry, DataFeed, DeletionActivityEntry, DocumentEntry, DocumentListEntry, DocumentListFeed, EditActivityEntry, EmailListEntry, EmailListFeed, EmailListRecipientEntry, EmailListRecipientFeed, Entry, EventEntry, EventFeed, FavoriteEntry, FavoriteFeed, FeatureEntry, FeatureFeed, Feed, FeedLinkEntry, FileCabinetPageEntry, FolderEntry, FriendEntry, FriendFeed, GenericEntry, GenericFeed, GoogleBaseEntry, GoogleBaseFeed, GoogleBaseMediaEntry, GoogleBaseMediaFeed, GphotoEntry, GphotoFeed, KeywordEntry, KeywordsFeed, ListEntry, ListFeed, ListItemEntry, ListPageEntry, MailItemEntry, MailItemFeed, MapEntry, MapFeed, MediaEntry, MediaFeed, MessageEntry, MessageEntry, MessageFeed, MessagesFeed, MoveActivityEntry, NicknameEntry, NicknameFeed, PageEntry, PdfEntry, PhotoEntry, PhotoEntry, PhotoFeed, PlaylistEntry, PlaylistFeed, PlaylistLinkEntry, PlaylistLinkFeed, PortfolioEntry, PortfolioFeed, PositionEntry, PositionFeed, PostCommentFeed, PostEntry, PresentationEntry, ProfileEntry, ProfileEntry, ProfileFeed, ProfileFeed, RatingEntry, RatingFeed, RecordEntry, RecordFeed, RecoveryActivityEntry, RegisterEntry, RegisterFeed, RevisionEntry, RevisionFeed, RevisionFeed, SidewikiEntry, SidewikiEntryFeed, SidewikiUserEntry, SidewikiUserFeed, SitemapsEntry, SitemapsFeed, SitemapsMobileEntry, SitemapsNewsEntry, SitemapsRegularEntry, SitesEntry, SitesFeed, SpreadsheetEntry, SpreadsheetEntry, SpreadsheetFeed, SubscriptionEntry, SubscriptionFeed, TableEntry, TableFeed, TagEntry, TransactionEntry, TransactionFeed, UserEntry, UserEntry, UserEventEntry, UserEventFeed, UserFeed, UserFeed, UserProfileEntry, UserProfileFeed, VersionEntry, VersionFeed, VideoEntry, VideoFeed, VideoMessageEntry, VideoMessageFeed, VolumeEntry, VolumeFeed, WebAttachmentEntry, WebPageEntry, WorksheetEntry, WorksheetFeed
public interface IAtom
Base interface for Atom resource types. Contains a common set of methods
across both entries and feeds and a can also be used as a parameter type in
contexts where either a feed or an entry is acceptable.
- See Also:
IEntry
,
IFeed
Method Summary |
ILink |
addLink(java.lang.String rel,
java.lang.String type,
java.lang.String href)
Adds a link with the given rel, type, and href. |
java.util.List<? extends IPerson> |
getAuthors()
Returns the list of all authors on this resource. |
java.util.Set<? extends ICategory> |
getCategories()
Returns a set of categories on this resource. |
java.lang.String |
getEtag()
Gets the value of the gd:etag attribute for this resource. |
java.lang.String |
getId()
Get the unique id for this resource. |
java.lang.String |
getKind()
Returns the value of the gd:kind attribute for this resource. |
ILink |
getLink(java.lang.String rel,
java.lang.String type)
Returns a particular atom:link element with the given rel and type, or null
if one was not found. |
java.util.List<? extends ILink> |
getLinks()
Returns a list of atom:link elements on this resource. |
ILink |
getSelfLink()
Returns the self link for the resource. |
ITextConstruct |
getTitle()
Returns the atom:title element of this resource. |
DateTime |
getUpdated()
Get a DateTime instance representing the last time this resource
was updated. |
java.lang.String |
getVersionId()
Version ID. |
void |
removeLinks()
Removes all links from the this resource. |
void |
removeLinks(java.lang.String relToMatch,
java.lang.String typeToMatch)
Remove all links that match the given rel and type values. |
void |
setEtag(java.lang.String etag)
Sets the value of the gd:etag attribute for this resource. |
void |
setId(java.lang.String id)
Sets the unique id for this resource. |
void |
setKind(java.lang.String kind)
Sets the value of the gd:kind attribute for this resource. |
void |
setService(Service s)
Sets the service that this resource is being used with. |
void |
setUpdated(DateTime updated)
Sets the last time this resource was updated. |
void |
setVersionId(java.lang.String versionId)
Sets the versionId. |
getAuthors
java.util.List<? extends IPerson> getAuthors()
- Returns the list of all authors on this resource.
getCategories
java.util.Set<? extends ICategory> getCategories()
- Returns a set of categories on this resource.
getId
java.lang.String getId()
- Get the unique id for this resource. Represents the atom:id element.
setId
void setId(java.lang.String id)
- Sets the unique id for this resource.
getUpdated
DateTime getUpdated()
- Get a
DateTime
instance representing the last time this resource
was updated. Represents the atom:updated element.
setUpdated
void setUpdated(DateTime updated)
- Sets the last time this resource was updated.
getLinks
java.util.List<? extends ILink> getLinks()
- Returns a list of atom:link elements on this resource. If there are no
links, an empty list will be returned.
getLink
ILink getLink(java.lang.String rel,
java.lang.String type)
- Returns a particular atom:link element with the given rel and type, or null
if one was not found.
addLink
ILink addLink(java.lang.String rel,
java.lang.String type,
java.lang.String href)
- Adds a link with the given rel, type, and href.
removeLinks
void removeLinks(java.lang.String relToMatch,
java.lang.String typeToMatch)
- Remove all links that match the given
rel
and type
values.
- Parameters:
relToMatch
- rel
value to match or null
to match any
rel
value.typeToMatch
- type
value to match or null
to match any
type
value.
removeLinks
void removeLinks()
- Removes all links from the this resource.
getSelfLink
ILink getSelfLink()
- Returns the self link for the resource.
getTitle
ITextConstruct getTitle()
- Returns the atom:title element of this resource.
getEtag
java.lang.String getEtag()
- Gets the value of the gd:etag attribute for this resource.
See RFC 2616, Section 3.11.
setEtag
void setEtag(java.lang.String etag)
- Sets the value of the gd:etag attribute for this resource.
getKind
java.lang.String getKind()
- Returns the value of the gd:kind attribute for this resource. Returns
null
if the kind attribute is missing.
setKind
void setKind(java.lang.String kind)
- Sets the value of the gd:kind attribute for this resource. A value of
null
will remove the kind attribute.
getVersionId
java.lang.String getVersionId()
- Version ID. This is a unique number representing this particular
resource. 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 or feed content 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 resources 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.
setService
void setService(Service s)
- Sets the service that this resource is being used with.