Interface | osid.workflow.rules.StepConstrainerSearchSession | ||
---|---|---|---|
Implements | osid.workflow.rules.StepConstrainerQuerySession | ||
Description |
This session provides methods for searching among This session defines views that offer differing behaviors for searching.
| ||
Method | getStepConstrainerSearch | ||
Description |
Gets a step constrainer search. | ||
Return | osid.workflow.rules.StepConstrainerSearch | the step constrainer search | |
Compliance | mandatory | This method must be implemented. | |
Method | getStepConstrainerSearchOrder | ||
Description |
Gets a step constrainer search order. The | ||
Return | osid.workflow.rules.StepConstrainerSearchOrder | the step constrainer search order | |
Compliance | mandatory | This method must be implemented. | |
Method | getStepConstrainersBySearch | ||
Description |
Gets the search results matching the given search query using the given search. | ||
Parameters | osid.workflow.rules.StepConstrainerQuery | stepConstrainerQuery | the step constrainer query |
osid.workflow.rules.StepConstrainerSearch | stepConstrainerSearch | the step constrainer search | |
Return | osid.workflow.rules.StepConstrainerSearchResults | the returned search results | |
Errors | NULL_ARGUMENT | stepConstrainerQuery or stepConstrainerSearch
is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | stepConstrainerQuery or stepConstrainerSearch
is not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getStepConstrainerQueryFromInspector | ||
Description |
Gets a step constrainer query from an inspector. The
inspector is available from a | ||
Parameters | osid.workflow.rules.StepConstrainerQueryInspector | stepConstrainerQueryInspector | a step constrainer query inspector |
Return | osid.workflow.rules.StepConstrainerQuery | the step constrainer query | |
Errors | NULL_ARGUMENT | stepConstrainerQueryInspector is null | |
UNSUPPORTED | stepConstrainerQueryInspector is not of this service | ||
Compliance | mandatory | This method must be implemented. |