org.sakaiproject.service.legacy.content
Interface ContentCollection

All Superinterfaces:
Entity
All Known Subinterfaces:
ContentCollectionEdit
All Known Implementing Classes:
BaseContentService.BaseCollectionEdit

public interface ContentCollection
extends Entity

ContentCollection is the core interface for a Collection object in the GenericContentHostingService.

A Collection has a list of internal members, each a resource id.

Version:
$Revision: 2371 $
Author:
University of Michigan, CHEF Software Development Team

Field Summary
 
Fields inherited from interface org.sakaiproject.service.legacy.entity.Entity
SEPARATOR
 
Method Summary
 long getBodySizeK()
          Access the size of all the resource body bytes within this collection in Kbytes.
 List getMemberResources()
          Access a List of the collections' internal members as full ContentResource or ContentCollection objects.
 List getMembers()
          Access a List of the collection's internal members, each a resource id String.
 
Methods inherited from interface org.sakaiproject.service.legacy.entity.Entity
getId, getProperties, getReference, getReference, getUrl, getUrl, toXml
 

Method Detail

getMembers

public List getMembers()
Access a List of the collection's internal members, each a resource id String.

Returns:
a List of the collection's internal members, each a resource id String (may be empty).

getMemberResources

public List getMemberResources()
Access a List of the collections' internal members as full ContentResource or ContentCollection objects.

Returns:
a List of the full objects of the members of the collection.

getBodySizeK

public long getBodySizeK()
Access the size of all the resource body bytes within this collection in Kbytes.

Returns:
The size of all the resource body bytes within this collection in Kbytes.