Interface | osid.configuration.rules.ParameterProcessorSearchSession | ||
---|---|---|---|
Implements | osid.configuration.rules.ParameterProcessorQuerySession | ||
Description |
This session provides methods for searching among This session defines views that offer differing behaviors for searching.
| ||
Method | getParameterProcessorSearch | ||
Description |
Gets a parameter processor search. | ||
Return | osid.configuration.rules.ParameterProcessorSearch | the parameter processor search | |
Compliance | mandatory | This method must be implemented. | |
Method | getParameterProcessorSearchOrder | ||
Description |
Gets a parameter processor search order. The | ||
Return | osid.configuration.rules.ParameterProcessorSearchOrder | the parameter processor search order | |
Compliance | mandatory | This method must be implemented. | |
Method | getParameterProcessorsBySearch | ||
Description |
Gets the search results matching the given search query using the given search. | ||
Parameters | osid.configuration.rules.ParameterProcessorQuery | parameterProcessorQuery | the parameter processor query |
osid.configuration.rules.ParameterProcessorSearch | parameterProcessorSearch | the parameter processor search | |
Return | osid.configuration.rules.ParameterProcessorSearchResults | the returned search results | |
Errors | NULL_ARGUMENT | parameterProcessorQuery or parameterProcessorSearch
is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | parameterProcessorQuery or parameterProcessorSearch
is not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getParameterProcessorQueryFromInspector | ||
Description |
Gets a parameter processor query from an inspector. The
inspector is available from a | ||
Parameters | osid.configuration.rules.ParameterProcessorQueryInspector | parameterProcessorQueryInspector | a parameter processor query inspector |
Return | osid.configuration.rules.ParameterProcessorQuery | the parameter processor query | |
Errors | NULL_ARGUMENT | parameterProcessorQueryInspector is null | |
UNSUPPORTED | parameterProcessorQueryInspector is not of this service | ||
Compliance | mandatory | This method must be implemented. |