OSID Specifications
recipe package
Version 3.0.0
Release Candidate Preview
recipe package
Version 3.0.0
Release Candidate Preview
| Interface | osid.recipe.CookbookSearch | ||
|---|---|---|---|
| Implements | osid.OsidSearch | ||
| Description |
The search interface for governing cook book searches. | ||
| Method | searchAmongCookbooks | ||
| Description |
Execute this search among the given list of cook books. | ||
| Parameters | osid.id.IdList | cookbookIds | list of cook books |
| Errors | NULL_ARGUMENT | cookbookIds is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderCookbookResults | ||
| Description |
Specify an ordering to the search results. | ||
| Parameters | osid.recipe.CookbookSearchOrder | cookbooksearchOrder | cook book search order |
| Errors | NULL_ARGUMENT | cookbooksearchOrder is null | |
| UNSUPPORTED | cookbooksearchOrder is not of this service | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getCookbookSearchRecord | ||
| Description |
Gets the cook book search record corresponding to the
given cook book search record | ||
| Parameters | osid.type.Type | cookbookSearchRecordType | a cook book search record type |
| Return | osid.recipe.records.CookbookSearchRecord | the cook book search record | |
| Errors | NULL_ARGUMENT | cookbooksearchRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(cookbooksearchRecordType) is false
| ||
| Compliance | mandatory | This method must be implemented. | |