Google Data APIs Client Library (1.41.1)



com.google.gdata.data
Interface IFeed

All Superinterfaces:
IAtom
All Known Implementing Classes:
AbPageVariationFeed, AccountFeed, AclFeed, ActivityFeed, AlbumFeed, AttendeeFeed, BaseEventFeed, BaseFeed, BaseHealthFeed, BlogCommentFeed, BlogFeed, BlogPostFeed, CalendarEventFeed, CalendarFeed, CaptionTrackFeed, CellFeed, ChannelFeed, CodeSearchFeed, CollectionFeed, CombinationFeed, CommentFeed, ComplaintFeed, ContactFeed, ContactFeed, ContactGroupFeed, ContentFeed, CrawlIssuesFeed, DataFeed, DocumentExportFeed, DocumentFeed, DocumentListFeed, EmailListFeed, EmailListRecipientFeed, EventFeed, ExperimentFeed, FavoriteFeed, FeatureFeed, Feed, FriendFeed, GenericFeed, GlossaryFeed, GoogleBaseFeed, GoogleBaseMediaFeed, GphotoFeed, IssueCommentsFeed, IssuesFeed, KeywordsFeed, ListFeed, MailItemFeed, MapFeed, MediaFeed, MessageFeed, MessagesFeed, MetadataFeed, NicknameFeed, PhotoFeed, PlaylistFeed, PlaylistLinkFeed, PortfolioFeed, PositionFeed, PostCommentFeed, ProfileFeed, ProfileFeed, RatingFeed, RecordFeed, RegisterFeed, RevisionFeed, RevisionFeed, SectionFeed, SidewikiEntryFeed, SidewikiUserFeed, SiteFeed, SitemapsFeed, SitesFeed, SpreadsheetFeed, SubscriptionFeed, TableFeed, TransactionFeed, TranslationMemoryFeed, UserEventFeed, UserFeed, UserFeed, UserProfileFeed, VariationFeed, VersionFeed, VideoFeed, VideoMessageFeed, VolumeFeed, WorksheetFeed

public interface IFeed
extends IAtom

Shared interface for model and data BaseFeed to implement.


Method Summary
 IEntry createEntry()
          Creates a new entry of the appropriate type for this feed.
 boolean getCanPost()
          Returns true if this feed accepts entries POSTed to it.
 java.util.List<? extends IEntry> getEntries()
          Returns a list of entries for this feed.
 ILink getEntryPostLink()
          Returns the entry post link for the 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.
 int getItemsPerPage()
          Gets the number of items that will be returned per page for paged feeds.
 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.
 int getStartIndex()
          Gets the starting index of the contained entries for paged feeds.
 ITextConstruct getSubtitle()
          Returns the atom:subtitle element of this feed.
 int getTotalResults()
          Gets the total number of results associated with this feed.
 void setCanPost(boolean canPost)
          Sets whether this feed accepts entries POSTed to it.
 IGenerator setGenerator(java.lang.String version, java.lang.String uri, java.lang.String name)
          Sets the atom:generator element on 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 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.
 
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, setService, setUpdated, setVersionId
 

Method Detail

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.


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.


createEntry

IEntry createEntry()
Creates a new entry of the appropriate type for this feed.


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.


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.