Interface | osid.recipe.ProcedureSearchResults | ||
---|---|---|---|
Implements | osid.OsidSearchResults | ||
Description |
This interface provides a means to capture results of a search. | ||
Method | getProcedures | ||
Description |
Gets the procedure list resulting from a search. | ||
Return | osid.recipe.ProcedureList | the procedure list | |
Errors | ILLEGAL_STATE | list has already been retrieved | |
Compliance | mandatory | This method must be implemented. | |
Method | getProcedureQueryInspector | ||
Description |
Gets the inspector for the query to examine the terns used in the search. | ||
Return | osid.recipe.ProcedureQueryInspector | the query inspector | |
Compliance | mandatory | This method must be implemented. | |
Method | getProcedureSearchResultsRecord | ||
Description |
Gets the procedure search results record corresponding
to the given procedure search record | ||
Parameters | osid.type.Type | procedureSearchRecordType | a procedure search record type |
Return | osid.recipe.records.ProcedureSearchResultsRecord | the procedure search record | |
Errors | NULL_ARGUMENT | procedureSearchRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(procedureSearchRecordType) is false
| ||
Compliance | mandatory | This method must be implemented. |