Interface | osid.inventory.ItemLookupSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session defines methods for retrieving items. An
This lookup session defines several views:
The methods Items may have an additional records indicated by their
respective record types. The record may not be accessed
through a cast of the | ||
Method | getWarehouseId | ||
Description |
Gets the | ||
Return | osid.id.Id | the Warehouse Id associated with this session | |
Compliance | mandatory | This method must be implemented. | |
Method | getWarehouse | ||
Description |
Gets the | ||
Return | osid.inventory.Warehouse | the warehouse | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canLookupItems | ||
Description |
Tests if this user can perform | ||
Return | boolean | false if lookup methods are not authorized, true
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | useComparativeItemView | ||
Description |
The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | usePlenaryItemView | ||
Description |
A complete view of the | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useFederatedWarehouseView | ||
Description |
Federates the view for methods in this session. A federated view will include items in catalogs which are children of this catalog in the warehouse hierarchy. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useIsolatedWarehouseView | ||
Description |
Isolates the view for methods in this session. An isolated view restricts retrievals to this warehouse only. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getItem | ||
Description |
Gets the | ||
Parameters | osid.id.Id | itemId | the Id of the Item to retrieve |
Return | osid.inventory.Item | the returned Item | |
Errors | NOT_FOUND | no Item found with the given Id | |
NULL_ARGUMENT | itemId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getItemsByIds | ||
Description |
Gets an | ||
Parameters | osid.id.IdList | itemIds | the list of Ids to retrieve |
Return | osid.inventory.ItemList | the returned Item list | |
Errors | NOT_FOUND | an Id was not found | |
NULL_ARGUMENT | itemIds is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getItemsByGenusType | ||
Description |
Gets an | ||
Parameters | osid.type.Type | itemGenusType | an item genus type |
Return | osid.inventory.ItemList | the returned Item list | |
Errors | NULL_ARGUMENT | itemGenusType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getItemsByParentGenusType | ||
Description |
Gets an | ||
Parameters | osid.type.Type | itemGenusType | an item genus type |
Return | osid.inventory.ItemList | the returned Item list | |
Errors | NULL_ARGUMENT | itemGenusType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getItemsByRecordType | ||
Description |
Gets an | ||
Parameters | osid.type.Type | itemRecordType | an item record type |
Return | osid.inventory.ItemList | the returned Item list | |
Errors | NULL_ARGUMENT | itemRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getItemsByStock | ||
Description |
Gets an | ||
Parameters | osid.id.Id | stockId | a stock Id |
Return | osid.inventory.ItemList | the returned Item list | |
Errors | NULL_ARGUMENT | stockId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getItemsByPropertyTag | ||
Description |
Gets an | ||
Parameters | string | property | a property number |
Return | osid.inventory.ItemList | the returned Item list | |
Errors | NULL_ARGUMENT | property is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getItemsBySerialNumber | ||
Description |
Gets an | ||
Parameters | string | serialNumber | a serial number |
Return | osid.inventory.ItemList | the returned Item list | |
Errors | NULL_ARGUMENT | serialNumber is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getItemParts | ||
Description |
Gets an | ||
Parameters | osid.id.Id | itemId | an item Id |
Return | osid.inventory.ItemList | the returned Item list | |
Errors | NULL_ARGUMENT | itemId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getItems | ||
Description |
Gets all | ||
Return | osid.inventory.ItemList | a list of Items | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |