| Interface | osid.workflow.rules.StepEnablerSearchResults | ||
|---|---|---|---|
| Implements | osid.OsidSearchResults | ||
| Used By | osid.workflow.rules.StepEnablerSearchSession | ||
| Description |
This interface provides a means to capture results of a search. | ||
| Method | getStepEnablers | ||
| Description |
Gets the step enabler list resulting from a search. | ||
| Return | osid.workflow.rules.StepEnablerList | the step enabler list | |
| Errors | ILLEGAL_STATE | list already retrieved | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getStepEnablerQueryInspector | ||
| Description |
Gets the inspector for the query to examine the terms used in the search. | ||
| Return | osid.workflow.rules.StepEnablerQueryInspector | the step enabler query inspector | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getStepEnablerSearchResultsRecord | ||
| Description |
Gets the step enabler search results 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.StepEnablerSearchResultsRecord | the step enabler search results 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. | |