OSID Specifications
recipe package
Version 3.0.0
recipe package
Version 3.0.0
| Interface | osid.recipe.CookbookSearchOrder | ||
|---|---|---|---|
| Implements | osid.OsidCatalogSearchOrder | ||
| Used By | osid.recipe.CookbookSearchSession | ||
| Description |
An interface for specifying the ordering of search results. | ||
| Method | getCookbookSearchOrderRecord | ||
| Description |
Gets the cookbook search order record corresponding to the given cookbook record Type. Multiple retrievals return the same underlying object. | ||
| Parameters | osid.type.Type | cookbookRecordType | a cookbook record type |
| Return | osid.recipe.records.CookbookSearchOrderRecord | the cookbook search order record | |
| Errors | NULL_ARGUMENT | cookbookRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(cookbookRecordType) is false | ||
| Compliance | mandatory | This method must be implemented. | |