| Interface | osid.workflow.StepSearch | ||
|---|---|---|---|
| Implements | osid.OsidSearch | ||
| Description |
The search interface for governing step searches. | ||
| Method | searchAmongSteps | ||
| Description |
Execute this search among the given list of steps. | ||
| Parameters | osid.id.IdList | stepIds | list of steps |
| Errors | NULL_ARGUMENT | stepIds is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderStepResults | ||
| Description |
Specify an ordering to the search results. | ||
| Parameters | osid.workflow.StepSearchOrder | stepSearchOrder | step search order |
| Errors | NULL_ARGUMENT | stepSearchOrder is null | |
| UNSUPPORTED | stepSearchOrder is not of this service | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getStepSearchRecord | ||
| Description |
Gets the step search record corresponding to the given
step search record | ||
| Parameters | osid.type.Type | stepSearchRecordType | a step search record type |
| Return | osid.workflow.records.StepSearchRecord | the step search record | |
| Errors | NULL_ARGUMENT | stepSearchRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(stepSearchRecordType) is false | ||
| Compliance | mandatory | This method must be implemented. | |