| Interface | osid.recipe.CookbookSearch | ||
|---|---|---|---|
| Implements | osid.OsidSearch | ||
| Used By | osid.recipe.CookbookSearchSession | ||
| Description |
The search interface for governing cookbook searches. | ||
| Method | searchAmongCookbooks | ||
| Description |
Execute this search among the given list of cookbooks. | ||
| Parameters | osid.id.IdList | cookbookIds | list of cookbooks |
| 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 | cookbook 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 cookbook search record corresponding to the
given cookbook search record | ||
| Parameters | osid.type.Type | cookbookSearchRecordType | a cookbook search record type |
| Return | osid.recipe.records.CookbookSearchRecord | the cookbook 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. | |