Interface | osid.inventory.WarehouseSearchResults | ||
---|---|---|---|
Implements | osid.OsidSearchResults | ||
Description |
This interface provides a means to capture results of a search. | ||
Method | getWarehouses | ||
Description |
Gets the warehouse list resulting from a search. | ||
Return | osid.inventory.WarehouseList | the warehouse list | |
Errors | ILLEGAL_STATE | the warehouse list has already been retrieved | |
Compliance | mandatory | This method must be implemented. | |
Method | getWarehouseQueryInspector | ||
Description |
Gets the inspector for the query to examine the terms used in the search. | ||
Return | osid.inventory.WarehouseQueryInspector | the query inspector | |
Compliance | mandatory | This method must be implemented. | |
Method | getWarehouseSearchResultsRecord | ||
Description |
Gets the warehouse search results record corresponding
to the given warehouse search record | ||
Parameters | osid.type.Type | warehouseSearchRecordType | a warehouse search record type |
Return | osid.inventory.records.WarehouseSearchResultsRecord | the warehouse search results record | |
Errors | NULL_ARGUMENT | warehousesearchRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(warehouseSearchRecordType) is false
| ||
Compliance | mandatory | This method must be implemented. |