| Interface | osid.installation.DepotSearch | ||
|---|---|---|---|
| Implements | osid.OsidSearch | ||
| Description |
The interface for governing depot searches. | ||
| Method | searchAmongDepots | ||
| Description |
Execute this search among the given list of depots. | ||
| Parameters | osid.id.IdList | depotIds | list of depots |
| Errors | NULL_ARGUMENT | depotIds is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderDepotResults | ||
| Description |
Specify an ordering to the search results. | ||
| Parameters | osid.installation.DepotSearchOrder | depotSearchOrder | depot search order |
| Errors | NULL_ARGUMENT | depotSearchOrder is null | |
| UNSUPPORTED | depotSearchOrder is not of this service | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getDepotSearchRecord | ||
| Description |
Gets the depot search record corresponding to the given
depot search record | ||
| Parameters | osid.type.Type | depotSearchRecordType | a depot search record type |
| Return | osid.installation.records.DepotSearchRecord | the depot search record | |
| Errors | NULL_ARGUMENT | depotSearchRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(depotSearchRecordType) is false | ||
| Compliance | mandatory | This method must be implemented. | |