org.apache.abdera.protocol.server
Interface CollectionInfo

All Known Subinterfaces:

MultipartRelatedCollectionInfo

All Known Implementing Classes:

org.apache.abdera.protocol.server.impl.AbstractCollectionAdapter, org.apache.abdera.protocol.server.impl.AbstractEntityCollectionAdapter, AbstractMultipartCollectionAdapter, BasicAdapter, CouchDbAdapter, EmployeeCollectionAdapter, FeedConfiguration, FilesystemAdapter, IBatisCollectionAdapter, JcrCollectionAdapter, ManagedCollectionAdapter, SimpleAdapter

public interface CollectionInfo

Metadata interface used by WorkspaceManager and Provider implementations to construct Atompub Service Documents. The CollectionInfo interface provides information used to construct an app:collection element

Method Summary

Collection	asCollectionElement(RequestContext request) Converts this to an instance of the FOM Collection interface
String[]	getAccepts(RequestContext request) Returns an array of MIME media types for the app:collection element's app:accept elements.
CategoriesInfo[]	getCategoriesInfo(RequestContext request) Return the collection of CategoriesInfo objects for the app:collection element's app:categories elements.
String	getHref(RequestContext request) Get the value of the app:collection element's href attribute.
String	getTitle(RequestContext request) Get the value of the app:collection element's atom:title element.

Method Detail

getHref

String getHref(RequestContext request)

Get the value of the app:collection element's href attribute. This must not be null

getTitle

String getTitle(RequestContext request)

Get the value of the app:collection element's atom:title element. This assumes that the title will be type="text". This must not be null;

getAccepts

String[] getAccepts(RequestContext request)

Returns an array of MIME media types for the app:collection element's app:accept elements. These tell a client which media types the collection will accept on a POST

getCategoriesInfo

CategoriesInfo[] getCategoriesInfo(RequestContext request)

Return the collection of CategoriesInfo objects for the app:collection element's app:categories elements. These tell a client which atom:category elements are defined for use in the collections atom:entries

asCollectionElement

Collection asCollectionElement(RequestContext request)

Converts this to an instance of the FOM Collection interface