OSID Specifications
recipe package
Version 3.0.0
Release Candidate Preview
recipe package
Version 3.0.0
Release Candidate Preview
| Interface | osid.recipe.CookbookSearchResults | ||
|---|---|---|---|
| Implements | osid.OsidSearchResults | ||
| Description |
This interface provides a means to capture results of a search. | ||
| Method | getCookbooks | ||
| Description |
Gets the cook book list resulting from a search. | ||
| Return | osid.recipe.CookbookList | the cook book list | |
| Errors | ILLEGAL_STATE | list has already been retrieved | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getCookbookQueryInspector | ||
| Description |
Gets the inspector for the query to examine the terns used in the search. | ||
| Return | osid.recipe.CookbookQueryInspector | the query inspector | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getCookbookSearchResultsRecord | ||
| Description |
Gets the cook book search rsults record corresponding to the given cook book search record Type. This method is used to retrieve an object implementing the requested record. | ||
| Parameters | osid.type.Type | cookbookSearchRecordType | a cook book search record type |
| Return | osid.recipe.records.CookbookSearchResultsRecord | the cook book search results 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. | |