Interface | osid.workflow.StepSearchResults | ||
---|---|---|---|
Implements | osid.OsidSearchResults | ||
Description |
This interface provides a means to capture results of a search. | ||
Method | getSteps | ||
Description |
Gets the step list resulting from a search. | ||
Return | osid.workflow.StepList | the step list | |
Errors | ILLEGAL_STATE | list already retrieved | |
Compliance | mandatory | This method must be implemented. | |
Method | getStepQueryInspector | ||
Description |
Gets the inspector for the query to examine the terms used in the search. | ||
Return | osid.workflow.StepQueryInspector | the step query inspector | |
Compliance | mandatory | This method must be implemented. | |
Method | getStepSearchResultsRecord | ||
Description |
Gets the step search results record corresponding to
the given step search record | ||
Parameters | osid.type.Type | stepSearchRecordType | a step search record type |
Return | osid.workflow.records.StepSearchResultsRecord | the step search results 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. |