| Interface | osid.provisioning.ProvisionableSearchResults | ||
|---|---|---|---|
| Implements | osid.OsidSearchResults | ||
| Description |
This interface provides a means to capture results of a search. | ||
| Method | getProvisionables | ||
| Description |
Gets the provisionable list resulting from a search. | ||
| Return | osid.provisioning.ProvisionableList | the provisionable list | |
| Errors | ILLEGAL_STATE | list already retrieved | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getProvisionableQueryInspector | ||
| Description |
Gets the inspector for the query to examine the terms used in the search. | ||
| Return | osid.provisioning.ProvisionableQueryInspector | the provisionable query inspector | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getProvisionableSearchResultsRecord | ||
| Description |
Gets the provisionable search results record
corresponding to the given provisionable search record
| ||
| Parameters | osid.type.Type | provisionableSearchRecordType | a provisionable search record type |
| Return | osid.provisioning.records.ProvisionableSearchResultsRecord | the provisionable search results record | |
| Errors | NULL_ARGUMENT | provisionableSearchRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(provisionableSearchRecordType) is false
| ||
| Compliance | mandatory | This method must be implemented. | |