| Interface | osid.workflow.rules.StepEnablerSearch | ||
|---|---|---|---|
| Implements | osid.OsidSearch | ||
| Used By | osid.workflow.rules.StepEnablerSearchSession | ||
| Description |
The search interface for governing step enabler searches. | ||
| Method | searchAmongStepEnablers | ||
| Description |
Execute this search among the given list of step enablers. | ||
| Parameters | osid.id.IdList | stepEnablerIds | list of step enablers |
| Errors | NULL_ARGUMENT | stepEnablerIds is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderStepEnablerResults | ||
| Description |
Specify an ordering to the search results. | ||
| Parameters | osid.workflow.rules.StepEnablerSearchOrder | stepEnablerSearchOrder | step enabler search order |
| Errors | NULL_ARGUMENT | stepEnablerSearchOrder is null | |
| UNSUPPORTED | stepEnablerSearchOrder is not of this service | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getStepEnablerSearchRecord | ||
| Description |
Gets the step enabler search record corresponding to
the given step enabler search record | ||
| Parameters | osid.type.Type | stepEnablerSearchRecordType | a step enabler search record type |
| Return | osid.workflow.rules.records.StepEnablerSearchRecord | the step enabler search record | |
| Errors | NULL_ARGUMENT | stepEnablerSearchRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(stepEnablerSearchRecordType) is
false | ||
| Compliance | mandatory | This method must be implemented. | |