|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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.
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. |
Method Detail |
---|
java.util.List<? extends IPerson> getAuthors()
java.util.Set<? extends ICategory> getCategories()
java.lang.String getId()
void setId(java.lang.String id)
DateTime getUpdated()
DateTime
instance representing the last time this resource
was updated. Represents the atom:updated element.
void setUpdated(DateTime updated)
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)
void removeLinks(java.lang.String relToMatch, java.lang.String typeToMatch)
rel
and type
values.
relToMatch
- rel
value to match or null
to match any
rel
value.typeToMatch
- type
value to match or null
to match any
type
value.void removeLinks()
ILink getSelfLink()
ITextConstruct getTitle()
java.lang.String getEtag()
void setEtag(java.lang.String etag)
java.lang.String getKind()
null
if the kind attribute is missing.
void setKind(java.lang.String kind)
null
will remove the kind attribute.
java.lang.String getVersionId()
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).
void setVersionId(java.lang.String versionId)
getVersionId()
for a description of what
the versionId is used for.
void setService(Service s)
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |