| Interface | osid.provisioning.rules.BrokerProcessorSearchResults | ||
|---|---|---|---|
| Implements | osid.OsidSearchResults | ||
| Description |
This interface provides a means to capture results of a search. | ||
| Method | getBrokerProcessors | ||
| Description |
Gets the | ||
| Return | osid.provisioning.rules.BrokerProcessorList | the broker processor list | |
| Errors | ILLEGAL_STATE | list has already been retrieved | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getBrokerProcessorQueryInspector | ||
| Description |
Gets the inspector for the query to examine the terms used in the search. | ||
| Return | osid.provisioning.rules.BrokerProcessorQueryInspector | the broker processor query inspector | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getBrokerProcessorSearchResultsRecord | ||
| Description |
Gets the broker processor search results record
corresponding to the given broker processor search record
| ||
| Parameters | osid.type.Type | brokerProcessorSearchRecordType | a broker processor search record type |
| Return | osid.provisioning.rules.records.BrokerProcessorSearchResultsRecord | the broker processor search results record | |
| Errors | NULL_ARGUMENT | brokerProcessorSearchRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure occurred | ||
| UNSUPPORTED | hasRecordType(brokerProcessorSearchRecordType) is
false | ||
| Compliance | mandatory | This method must be implemented. | |