Interface | osid.recipe.ProcedureSearch | ||
---|---|---|---|
Implements | osid.OsidSearch | ||
Description |
The search interface for governing procedure searches. | ||
Method | searchAmongProcedures | ||
Description |
Execute this search among the given list of procedures. | ||
Parameters | osid.id.IdList | procedureIds | list of procedures |
Errors | NULL_ARGUMENT | procedureIds is null | |
Compliance | mandatory | This method must be implemented. | |
Method | orderProcedureResults | ||
Description |
Specify an ordering to the search results. | ||
Parameters | osid.recipe.ProcedureSearchOrder | procedureSearchOrder | procedure search order |
Errors | NULL_ARGUMENT | procedureSearchOrder is null | |
UNSUPPORTED | procedureSearchOrder is not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getProcedureSearchRecord | ||
Description |
Gets the procedure search record corresponding to the
given procedure search record | ||
Parameters | osid.type.Type | procedureSearchRecordType | a procedure search record type |
Return | osid.recipe.records.ProcedureSearchRecord | 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. |