OSID Specifications
provisioning package
Version 3.0.0
Release Candidate Preview
provisioning package
Version 3.0.0
Release Candidate Preview
| Interface | osid.provisioning.ProvisionSearchResults | ||
|---|---|---|---|
| Implements | osid.OsidSearchResults | ||
| Description |
This interface provides a means to capture results of a search. | ||
| Method | getProvisions | ||
| Description |
Gets the provision list resulting from a search. | ||
| Return | osid.provisioning.ProvisionList | the provision list | |
| Errors | ILLEGAL_STATE | list already retrieved | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getProvisionQueryInspector | ||
| Description |
Gets the inspector for the query to examine the terms used in the search. | ||
| Return | osid.provisioning.ProvisionQueryInspector | the provision query inspector | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getProvisionSearchResultsRecord | ||
| Description |
Gets the provision search results record corresponding
to the given provision search record | ||
| Parameters | osid.type.Type | provisionSearchRecordType | a provision search record type |
| Return | osid.provisioning.records.ProvisionSearchResultsRecord | the provision search results record | |
| Errors | NULL_ARGUMENT | provisionSearchRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(provisionSearchRecordType) is false
| ||
| Compliance | mandatory | This method must be implemented. | |