Interface | osid.provisioning.rules.BrokerProcessorSearchSession | ||
---|---|---|---|
Implements | osid.provisioning.rules.BrokerProcessorQuerySession | ||
Description |
This session provides methods for searching among This session defines views that offer differing behaviors for searching.
| ||
Method | getBrokerProcessorSearch | ||
Description |
Gets a broker processor search. | ||
Return | osid.provisioning.rules.BrokerProcessorSearch | the broker processor search | |
Compliance | mandatory | This method must be implemented. | |
Method | getBrokerProcessorSearchOrder | ||
Description |
Gets a broker processor search order. The | ||
Return | osid.provisioning.rules.BrokerProcessorSearchOrder | the broker processor search order | |
Compliance | mandatory | This method must be implemented. | |
Method | getBrokerProcessorsBySearch | ||
Description |
Gets the search results matching the given search query using the given search. | ||
Parameters | osid.provisioning.rules.BrokerProcessorQuery | brokerProcessorQuery | the broker processor query |
osid.provisioning.rules.BrokerProcessorSearch | brokerProcessorSearch | the broker processor search | |
Return | osid.provisioning.rules.BrokerProcessorSearchResults | the returned search results | |
Errors | NULL_ARGUMENT | brokerProcessorQuery or brokerProcessorSearch
is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | brokerProcessorQuery or brokerProcessorSearch
is not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getBrokerProcessorQueryFromInspector | ||
Description |
Gets a broker processor query from an inspector. The
inspector is available from a | ||
Parameters | osid.provisioning.rules.BrokerProcessorQueryInspector | brokerProcessorQueryInspector | a broker processor query inspector |
Return | osid.provisioning.rules.BrokerProcessorQuery | the broker processor query | |
Errors | NULL_ARGUMENT | brokerProcessorQueryInspector is null | |
UNSUPPORTED | brokerProcessorQueryInspector is not of this service | ||
Compliance | mandatory | This method must be implemented. |