| Interface | osid.inventory.InventorySearchResults | ||
|---|---|---|---|
| Implements | osid.OsidSearchResults | ||
| Description |
This interface provides a means to capture results of a search. | ||
| Method | getInventories | ||
| Description |
Gets the inventory list resulting from a search. | ||
| Return | osid.inventory.InventoryList | the inventory list | |
| Errors | ILLEGAL_STATE | the inventory list has already been retrieved | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getInventoryQueryInspector | ||
| Description |
Gets the inspector for the query to examine the terms used in the search. | ||
| Return | osid.inventory.InventoryQueryInspector | the query inspector | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getInventorySearchResultsRecord | ||
| Description |
Gets the inventory search results record corresponding
to the given inventory search record | ||
| Parameters | osid.type.Type | inventorySearchRecordType | a inventory search record type |
| Return | osid.inventory.records.InventorySearchResultsRecord | the inventory search interface | |
| Errors | NULL_ARGUMENT | inventorySearchRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(inventorySearchRecordType) is false
| ||
| Compliance | mandatory | This method must be implemented. | |