OSID Specifications
inventory package
Version 3.0.0
Release Candidate Preview
inventory package
Version 3.0.0
Release Candidate Preview
| Interface | osid.inventory.ModelSearch | ||
|---|---|---|---|
| Implements | osid.OsidSearch | ||
| Description |
The search interface for governing model searches. | ||
| Method | searchAmongModels | ||
| Description |
Execute this search among the given list of models. | ||
| Parameters | osid.id.IdList | modelIds | list of models |
| Errors | NULL_ARGUMENT | modelIds is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderModelResults | ||
| Description |
Specify an ordering to the search results. | ||
| Parameters | osid.inventory.ModelSearchOrder | modelSearchOrder | model search order |
| Errors | NULL_ARGUMENT | modelSearchOrder is null | |
| UNSUPPORTED | modelSearchOrder is not of this service | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getModelSearchRecord | ||
| Description |
Gets the model search record corresponding to the given
model search record | ||
| Parameters | osid.type.Type | modelSearchRecordType | a model search record type |
| Return | osid.inventory.records.ModelSearchRecord | the model search record | |
| Errors | NULL_ARGUMENT | modelSearchRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(modelSearchRecordType) is false | ||
| Compliance | mandatory | This method must be implemented. | |