Interface | osid.workflow.rules.StepProcessorSearchResults | ||
---|---|---|---|
Implements | osid.OsidSearchResults | ||
Description |
This interface provides a means to capture results of a search. | ||
Method | getStepProcessors | ||
Description |
Gets the | ||
Return | osid.workflow.rules.StepProcessorList | the step processor list | |
Errors | ILLEGAL_STATE | list has already been retrieved | |
Compliance | mandatory | This method must be implemented. | |
Method | getStepProcessorQueryInspector | ||
Description |
Gets the inspector for the query to examine the terms used in the search. | ||
Return | osid.workflow.rules.StepProcessorQueryInspector | the step processor query inspector | |
Compliance | mandatory | This method must be implemented. | |
Method | getStepProcessorSearchResultsRecord | ||
Description |
Gets the step processor search results record
corresponding to the given step processor search record
| ||
Parameters | osid.type.Type | stepProcessorSearchRecordType | a step processor search record type |
Return | osid.workflow.rules.records.StepProcessorSearchResultsRecord | the step processor search results record | |
Errors | NULL_ARGUMENT | stepProcessorSearchRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure occurred | ||
UNSUPPORTED | hasRecordType(stepProcessorSearchRecordType) is false
| ||
Compliance | mandatory | This method must be implemented. |