|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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 |
---|
java.lang.String getId()
void setId(java.lang.String id)
DateTime getUpdated()
void setUpdated(DateTime v)
java.lang.String getEtag()
null
indicates the value is unknown.
void setEtag(java.lang.String etag)
null
indicates the value is unknown.
java.lang.String getLogo()
void setLogo(java.lang.String logo)
ITextConstruct getTitle()
ITextConstruct getSubtitle()
IGenerator getGenerator()
IGenerator setGenerator(java.lang.String version, java.lang.String uri, java.lang.String name)
boolean getCanPost()
void setCanPost(boolean canPost)
int getTotalResults()
Query.UNDEFINED
indicates the total size is undefined.
void setTotalResults(int totalResults)
Query.UNDEFINED
indicates the total size is undefined.
int getStartIndex()
Query.UNDEFINED
indicates the start index is undefined.
void setStartIndex(int startIndex)
Query.UNDEFINED
indicates the start index is undefined.
int getItemsPerPage()
Query.UNDEFINED
indicates the page item count is
undefined.
void setItemsPerPage(int numResults)
Query.UNDEFINED
indicates the page item count is
undefined.
void setService(Service s)
java.util.List<? extends IEntry> getEntries()
ILink getEntryPostLink()
ILink getSelfLink()
ILink getNextLink()
null
for none.ILink getPreviousLink()
null
for none.ILink getFeedBatchLink()
null
for none.java.util.List<? extends ILink> getLinks()
ILink getLink(java.lang.String rel, java.lang.String type)
ILink addLink(java.lang.String rel, java.lang.String type, java.lang.String href)
java.util.Set<? extends ICategory> getCategories()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |