| Interface | osid.provisioning.ProvisionableSearch | ||
|---|---|---|---|
| Implements | osid.OsidSearch | ||
| Description |
The search interface for governing provisionable searches. | ||
| Method | searchAmongProvisionables | ||
| Description |
Execute this search among the given list of provisionables. | ||
| Parameters | osid.id.IdList | provisionableIds | list of provisionables |
| Errors | NULL_ARGUMENT | provisionableIds is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderProvisionableResults | ||
| Description |
Specify an ordering to the search results. | ||
| Parameters | osid.provisioning.ProvisionableSearchOrder | provisionableSearchOrder | provisionable search order |
| Errors | NULL_ARGUMENT | provisionableSearchOrder is null | |
| UNSUPPORTED | provisionableSearchOrder is not of this service | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getProvisionableSearchRecord | ||
| Description |
Gets the provisionable search record corresponding to
the given provisionable search record | ||
| Parameters | osid.type.Type | provisionableSearchRecordType | a provisionable search record type |
| Return | osid.provisioning.records.ProvisionableSearchRecord | the provisionable search interface | |
| Errors | NULL_ARGUMENT | provisionableSearchRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(provisionableSearchRecordType) is false
| ||
| Compliance | mandatory | This method must be implemented. | |