Interface | osid.workflow.rules.StepConstrainerSearchResults | ||
---|---|---|---|
Implements | osid.OsidSearchResults | ||
Description |
This interface provides a means to capture results of a search. | ||
Method | getStepConstrainers | ||
Description |
Gets the | ||
Return | osid.workflow.rules.StepConstrainerList | the step constrainer list | |
Errors | ILLEGAL_STATE | list has already been retrieved | |
Compliance | mandatory | This method must be implemented. | |
Method | getStepConstrainerQueryInspector | ||
Description |
Gets the inspector for the query to examine the terms used in the search. | ||
Return | osid.workflow.rules.StepConstrainerQueryInspector | the step constrainer query inspector | |
Compliance | mandatory | This method must be implemented. | |
Method | getStepConstrainerSearchResultsRecord | ||
Description |
Gets the step constrainer search results record
corresponding to the given step constrainer search record
| ||
Parameters | osid.type.Type | stepConstrainerSearchRecordType | a step constrainer search record type |
Return | osid.workflow.rules.records.StepConstrainerSearchResultsRecord | the step constrainer search results record | |
Errors | NULL_ARGUMENT | stepConstrainerSearchRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure occurred | ||
UNSUPPORTED | hasRecordType(stepConstrainerSearchRecordType) is
false | ||
Compliance | mandatory | This method must be implemented. |