org.osid.commenting

Interface Book

All Superinterfaces:

Browsable, Extensible, Federateable, Identifiable, OsidCatalog, OsidObject, Sourceable

public interface Book
extends OsidCatalog

A Book represents a collection of comments. Like all OSID objects, a Book is identified by its Id and any persisted references should use the Id.

Method Summary

Methods

Modifier and Type	Method and Description
BookRecord	getBookRecord(Type bookRecordType) Gets the book record corresponding to the given Book record Type.

Methods inherited from interface org.osid.OsidObject

getDescription, getDisplayName, getGenusType, isOfGenusType

Methods inherited from interface org.osid.Identifiable

getId, isCurrent

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.Browsable

getProperties, getPropertiesByRecordType

Methods inherited from interface org.osid.Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Method Detail

getBookRecord

BookRecord getBookRecord(Type bookRecordType)
                         throws OperationFailedException

Gets the book record corresponding to the given Book record Type. This method is used to retrieve an object implementing the requested record. The bookRecordType may be the Type returned in getRecordTypes() or any of its parents in a Type hierarchy where hasRecordType(bookRecordType) is true .

Parameters:

bookRecordType - the type of book record to retrieve

Returns:

the book record

Throws:

NullArgumentException - bookRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(bookRecordType) is false

Compliance:

mandatory - This method must be implemented.