Interface | osid.workflow.rules.StepProcessorSearchSession | ||
---|---|---|---|
Implements | osid.workflow.rules.StepProcessorQuerySession | ||
Description |
This session provides methods for searching among This session defines views that offer differing behaviors for searching.
| ||
Method | getStepProcessorSearch | ||
Description |
Gets a step processor search. | ||
Return | osid.workflow.rules.StepProcessorSearch | the step processor search | |
Compliance | mandatory | This method must be implemented. | |
Method | getStepProcessorSearchOrder | ||
Description |
Gets a step processor search order. The | ||
Return | osid.workflow.rules.StepProcessorSearchOrder | the step processor search order | |
Compliance | mandatory | This method must be implemented. | |
Method | getStepProcessorsBySearch | ||
Description |
Gets the search results matching the given search query using the given search. | ||
Parameters | osid.workflow.rules.StepProcessorQuery | stepProcessorQuery | the step processor query |
osid.workflow.rules.StepProcessorSearch | stepProcessorSearch | the step processor search | |
Return | osid.workflow.rules.StepProcessorSearchResults | the returned search results | |
Errors | NULL_ARGUMENT | stepProcessorQuery or stepProcessorSearch is
null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | stepProcessorQuery or stepProcessorSearch is
not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getStepProcessorQueryFromInspector | ||
Description |
Gets a step processor query from an inspector. The
inspector is available from a | ||
Parameters | osid.workflow.rules.StepProcessorQueryInspector | stepProcessorQueryInspector | a step processor query inspector |
Return | osid.workflow.rules.StepProcessorQuery | the step processor query | |
Errors | NULL_ARGUMENT | stepProcessorQueryInspector is null | |
UNSUPPORTED | stepProcessorQueryInspector is not of this service | ||
Compliance | mandatory | This method must be implemented. |