org.osid.recipe

Interface Cookbook

All Superinterfaces:

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

public interface Cookbook
extends OsidCatalog

An Cookbook represents a collection of awards and procedures. Like all OSID objects, a Cookbook is identified by its Id and any persisted references should use the Id.

Method Summary

Methods

Modifier and Type	Method and Description
CookbookRecord	getCookbookRecord(Type cookbookRecordType) Gets the cook book record corresponding to the given Cookbook 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

getCookbookRecord

CookbookRecord getCookbookRecord(Type cookbookRecordType)
                                 throws OperationFailedException

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

Parameters:

cookbookRecordType - the type of cook book record to retrieve

Returns:

the cook book record

Throws:

NullArgumentException - cookbookRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(cookbookRecordType) is false

Compliance:

mandatory - This method must be implemented.