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.
Modifier and Type | Method and Description |
---|---|
CookbookRecord |
getCookbookRecord(Type cookbookRecordType)
Gets the cook book record corresponding to the given
Cookbook
record Type. |
getDescription, getDisplayName, getGenusType, isOfGenusType
getId, isCurrent
getRecordTypes, hasRecordType
getProperties, getPropertiesByRecordType
getBranding, getBrandingIds, getLicense, getProvider, getProviderId
CookbookRecord getCookbookRecord(Type cookbookRecordType) throws OperationFailedException
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
.cookbookRecordType
- the type of cook book record to retrieveNullArgumentException
- cookbookRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(cookbookRecordType)
is false
mandatory
- This method must be implemented.