Interface | osid.provisioning.BrokerSearchSession | ||
---|---|---|---|
Implements | osid.provisioning.BrokerQuerySession | ||
Description |
This session provides methods for searching among This session defines views that offer differing behaviors for searching.
Brokers may have a query record indicated by their
respective record types. The query record is accessed via the
| ||
Method | getBrokerSearch | ||
Description |
Gets a broker search. | ||
Return | osid.provisioning.BrokerSearch | the broker search | |
Compliance | mandatory | This method must be implemented. | |
Method | getBrokerSearchOrder | ||
Description |
Gets a broker search order. The | ||
Return | osid.provisioning.BrokerSearchOrder | the broker search order | |
Compliance | mandatory | This method must be implemented. | |
Method | getBrokersBySearch | ||
Description |
Gets the search results matching the given search query using the given search. | ||
Parameters | osid.provisioning.BrokerQuery | brokerQuery | the broker query |
osid.provisioning.BrokerSearch | brokerSearch | the broker search | |
Return | osid.provisioning.BrokerSearchResults | the returned search results | |
Errors | NULL_ARGUMENT | brokerQuery or brokerSearch is null
| |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | brokerQuery or brokerSearch is not of this
service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getBrokerQueryFromInspector | ||
Description |
Gets a broker query from an inspector. The inspector is
available from a | ||
Parameters | osid.provisioning.BrokerQueryInspector | brokerQueryInspector | a broker query inspector |
Return | osid.provisioning.BrokerQuery | the broker query | |
Errors | NULL_ARGUMENT | brokerQueryInspector is null | |
UNSUPPORTED | brokerQueryInspector is not of this service | ||
Compliance | mandatory | This method must be implemented. |