com.google.gdata.data
Interface IFeed

All Known Implementing Classes:
AclFeed, AlbumFeed, AttendeeFeed, BaseEventFeed, BaseFeed, BaseHealthFeed, BlogCommentFeed, BlogFeed, BlogPostFeed, CalendarEventFeed, CalendarFeed, CellFeed, CodeSearchFeed, CollectionFeed, CommentFeed, ComplaintFeed, ContactFeed, ContactFeed, ContactGroupFeed, CrawlIssuesFeed, DocumentListFeed, EmailListFeed, EmailListRecipientFeed, EventFeed, Feed, FriendFeed, GenericFeed, GoogleBaseFeed, GoogleBaseMediaFeed, GphotoFeed, KeywordsFeed, ListFeed, MailItemFeed, MediaFeed, MessageFeed, MessagesFeed, NicknameFeed, PhotoFeed, PlaylistFeed, PlaylistLinkFeed, PortfolioFeed, PositionFeed, PostCommentFeed, ProfileFeed, RatingFeed, RegisterFeed, SitemapsFeed, SitesFeed, SpreadsheetFeed, SubscriptionFeed, TransactionFeed, UserFeed, UserFeed, UserProfileFeed, VideoFeed, VideoMessageFeed, VolumeFeed, WorksheetFeed

public interface IFeed

Shared interface for model and data BaseFeed to implement.


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.
 boolean getCanPost()
          Returns true if this feed accepts entries POSTed to it.
 java.util.Set<? extends ICategory> getCategories()
          Returns a set of categories on this feed.
 java.util.List<? extends IEntry> getEntries()
          Returns a list of entries for this feed.
 ILink getEntryPostLink()
          Returns the entry post link for the feed.
 java.lang.String getEtag()
          Returns the current entity tag value for this feed.
 ILink getFeedBatchLink()
          Returns the link that provides the URI that can be used to batch operations to query, insert, update and delete entries on this feed.
 IGenerator getGenerator()
          Returns the atom:generator element on this feed.
 java.lang.String getId()
          Get the unique id for this feed.
 int getItemsPerPage()
          Gets the number of items that will be returned per page for paged feeds.
 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 feed.
 java.lang.String getLogo()
          Returns the value of the atom:logo element.
 ILink getNextLink()
          Returns the link that provides the URI of next page in a paged feed.
 ILink getPreviousLink()
          Returns the link that provides the URI of previous page in a paged feed.
 ILink getSelfLink()
          Returns the self link for the feed.
 int getStartIndex()
          Gets the starting index of the contained entries for paged feeds.
 ITextConstruct getSubtitle()
          Returns the atom:subtitle element of this feed.
 ITextConstruct getTitle()
          Returns the atom:title element of this feed.
 int getTotalResults()
          Gets the total number of results associated with this feed.
 DateTime getUpdated()
          The value of the atom:updated element, the date this feed was updated.
 void setCanPost(boolean canPost)
          Sets whether this feed accepts entries POSTed to it.
 void setEtag(java.lang.String etag)
          Sets the current entity tag value (for this feed.
 IGenerator setGenerator(java.lang.String version, java.lang.String uri, java.lang.String name)
          Sets the atom:generator element on this feed.
 void setId(java.lang.String id)
          Sets the unique id for this feed.
 void setItemsPerPage(int numResults)
          Sets the number of items that will be returned per page for paged feeds.
 void setLogo(java.lang.String logo)
          Sets the value of the logo field on this feed.
 void setService(Service s)
          Sets the service that this entry is being used with.
 void setStartIndex(int startIndex)
          Sets the starting index of the contained entries for paged feeds.
 void setTotalResults(int totalResults)
          Sets the total number of results associated with this feed.
 void setUpdated(DateTime v)
          Sets the value of the atom:updated element, which is the date this feed was last updated.
 

Method Detail

getId

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


setId

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


getUpdated

DateTime getUpdated()
The value of the atom:updated element, the date this feed was updated.


setUpdated

void setUpdated(DateTime v)
Sets the value of the atom:updated element, which is the date this feed was last updated.


getEtag

java.lang.String getEtag()
Returns the current entity tag value for this feed. A value of null indicates the value is unknown.


setEtag

void setEtag(java.lang.String etag)
Sets the current entity tag value (for this feed. A value of null indicates the value is unknown.


getLogo

java.lang.String getLogo()
Returns the value of the atom:logo element.


setLogo

void setLogo(java.lang.String logo)
Sets the value of the logo field on this feed.


getTitle

ITextConstruct getTitle()
Returns the atom:title element of this feed.


getSubtitle

ITextConstruct getSubtitle()
Returns the atom:subtitle element of this feed.


getGenerator

IGenerator getGenerator()
Returns the atom:generator element on this feed.


setGenerator

IGenerator setGenerator(java.lang.String version,
                        java.lang.String uri,
                        java.lang.String name)
Sets the atom:generator element on this feed. This method will create the appropriate type of element or extension based on the data model in use.


getCanPost

boolean getCanPost()
Returns true if this feed accepts entries POSTed to it.


setCanPost

void setCanPost(boolean canPost)
Sets whether this feed accepts entries POSTed to it.


getTotalResults

int getTotalResults()
Gets the total number of results associated with this feed. The value may be larger than the number of contained entries for paged feeds. A value of Query.UNDEFINED indicates the total size is undefined.


setTotalResults

void setTotalResults(int totalResults)
Sets the total number of results associated with this feed. The value may be larger than the number of contained entries for paged feeds. A value of Query.UNDEFINED indicates the total size is undefined.


getStartIndex

int getStartIndex()
Gets the starting index of the contained entries for paged feeds. A value of Query.UNDEFINED indicates the start index is undefined.


setStartIndex

void setStartIndex(int startIndex)
Sets the starting index of the contained entries for paged feeds. A value of Query.UNDEFINED indicates the start index is undefined.


getItemsPerPage

int getItemsPerPage()
Gets the number of items that will be returned per page for paged feeds. A value of Query.UNDEFINED indicates the page item count is undefined.


setItemsPerPage

void setItemsPerPage(int numResults)
Sets the number of items that will be returned per page for paged feeds. A value of Query.UNDEFINED indicates the page item count is undefined.


setService

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


getEntries

java.util.List<? extends IEntry> getEntries()
Returns a list of entries for this feed. The actual type of this list will depend on the data model used for the Feed.


getEntryPostLink

ILink getEntryPostLink()
Returns the entry post link for the feed.


getSelfLink

ILink getSelfLink()
Returns the self link for the feed.


getNextLink

ILink getNextLink()
Returns the link that provides the URI of next page in a paged feed.

Returns:
Link that provides the URI of next page in a paged feed or null for none.

getPreviousLink

ILink getPreviousLink()
Returns the link that provides the URI of previous page in a paged feed.

Returns:
Link that provides the URI of previous page in a paged feed or null for none.

getFeedBatchLink

ILink getFeedBatchLink()
Returns the link that provides the URI that can be used to batch operations to query, insert, update and delete entries on this feed.

Returns:
Link that provides the URI that can be used to batch operations to query, insert, update and delete entries on this feed or null for none.

getLinks

java.util.List<? extends ILink> getLinks()
Returns a list of atom:link elements on this feed. 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.


getCategories

java.util.Set<? extends ICategory> getCategories()
Returns a set of categories on this feed.