OSID Logo
OSID Specifications
commenting package
Version 3.0.0
Release Candidate Preview
Interfaceosid.commenting.Book
Implementsosid.OsidCatalog
Description

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.

MethodgetBookRecord
Description

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 .

Parametersosid.type.TypebookRecordTypethe type of book record to retrieve
Returnosid.commenting.records.BookRecordthe book record
ErrorsNULL_ARGUMENT bookRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(bookRecordType) is false
CompliancemandatoryThis method must be implemented.