Interface | osid.provisioning.DistributorSearchResults | ||
---|---|---|---|
Implements | osid.OsidSearchResults | ||
Description |
This interface provides a means to capture results of a search. | ||
Method | getDistributors | ||
Description |
Gets the distributor list resulting from a search. | ||
Return | osid.provisioning.DistributorList | the distributor list | |
Errors | ILLEGAL_STATE | list already retrieved | |
Compliance | mandatory | This method must be implemented. | |
Method | getDistributorQueryInspector | ||
Description |
Gets the inspector for the query to examine the terms used in the search. | ||
Return | osid.provisioning.DistributorQueryInspector | the distributor query inspector | |
Compliance | mandatory | This method must be implemented. | |
Method | getDistributorSearchResultsRecord | ||
Description |
Gets the distributor search results record
corresponding to the given distributor search record
| ||
Parameters | osid.type.Type | distributorSearchRecordType | a distributor search record type |
Return | osid.provisioning.records.DistributorSearchResultsRecord | the distributor search results record | |
Errors | NULL_ARGUMENT | distributorSearchRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(distributorSearchRecordType) is false
| ||
Compliance | mandatory | This method must be implemented. |