| Interface | osid.provisioning.rules.BrokerEnablerSearchResults | ||
|---|---|---|---|
| Implements | osid.OsidSearchResults | ||
| Used By | osid.provisioning.rules.BrokerEnablerSearchSession | ||
| Description |
This interface provides a means to capture results of a search. | ||
| Method | getBrokerEnablers | ||
| Description |
Gets the broker enabler list resulting from a search. | ||
| Return | osid.provisioning.rules.BrokerEnablerList | the broker enabler list | |
| Errors | ILLEGAL_STATE | list already retrieved | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getBrokerEnablerQueryInspector | ||
| Description |
Gets the inspector for the query to examine the terms used in the search. | ||
| Return | osid.provisioning.rules.BrokerEnablerQueryInspector | the broker enabler query inspector | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getBrokerEnablerSearchResultsRecord | ||
| Description |
Gets the broker enabler search results record
corresponding to the given broker enabler search record
| ||
| Parameters | osid.type.Type | brokerEnablerSearchRecordType | a broker enabler search record type |
| Return | osid.provisioning.rules.records.BrokerEnablerSearchResultsRecord | the broker enabler search results record | |
| Errors | NULL_ARGUMENT | brokerEnablerSearchRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(brokerEnablerSearchRecordType) is
false | ||
| Compliance | mandatory | This method must be implemented. | |