| Interface | osid.recipe.ProcedureSearchSession | ||
|---|---|---|---|
| Implements | osid.recipe.ProcedureQuerySession | ||
| Description |
This session provides methods for searching Procedures may have a query record indicated by their
respective record types. The query record is accessed via the
| ||
| Method | getProcedureSearch | ||
| Description |
Gets a procedure search. | ||
| Return | osid.recipe.ProcedureSearch | the procedure search | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getProcedureSearchOrder | ||
| Description |
Gets a procedure search order. The | ||
| Return | osid.recipe.ProcedureSearchOrder | the procedure search order interface | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getProceduresBySearch | ||
| Description |
Gets the search results matching the given search. | ||
| Parameters | osid.recipe.ProcedureQuery | procedureQuery | the procedure query |
osid.recipe.ProcedureSearch | procedureSearch | the procedure search | |
| Return | osid.recipe.ProcedureSearchResults | the procedure search results | |
| Errors | NULL_ARGUMENT | procedureQuery or procedureSearch is
null | |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| UNSUPPORTED | procedureQuery or procedureSearch is not of
this service | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getProcedureQueryFromInspector | ||
| Description |
Gets a procedure query from an inspector. The inspector
is available from a | ||
| Parameters | osid.recipe.ProcedureQueryInspector | procedureQueryInspector | a procedure query inspector |
| Return | osid.recipe.ProcedureQuery | the procedure query | |
| Errors | NULL_ARGUMENT | procedureQueryInspector is null | |
| UNSUPPORTED | procedureQueryInspector is not of this service | ||
| Compliance | mandatory | This method must be implemented. | |