OSID Specifications
inventory package
Version 3.0.0
Release Candidate Preview
inventory package
Version 3.0.0
Release Candidate Preview
| Interface | osid.inventory.InventorySearch | ||
|---|---|---|---|
| Implements | osid.OsidSearch | ||
| Description |
The search interface for governing inventory searches. | ||
| Method | searchAmongInventories | ||
| Description |
Execute this search among the given list of inventories. | ||
| Parameters | osid.id.IdList | inventoryIds | list of inventories |
| Errors | NULL_ARGUMENT | inventoryIds is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderInventoryResults | ||
| Description |
Specify an ordering to the search results. | ||
| Parameters | osid.inventory.InventorySearchOrder | inventorySearchOrder | inventory search order |
| Errors | NULL_ARGUMENT | inventorySearchOrder is null | |
| UNSUPPORTED | inventorySearchOrder is not of this service | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getInventorySearchRecord | ||
| Description |
Gets the inventory search record corresponding to the
given inventory search record | ||
| Parameters | osid.type.Type | inventorySearchRecordType | a inventory search record type |
| Return | osid.inventory.records.InventorySearchRecord | the inventory search record | |
| Errors | NULL_ARGUMENT | inventorySearchRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(inventorySearchRecordType) is false
| ||
| Compliance | mandatory | This method must be implemented. | |