Interface | osid.inventory.shipment.ShipmentLookupSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session defines methods for retrieving shipments. A
This lookup session defines several views:
The methods Shipments 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 | canLookupShipments | ||
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 | useComparativeShipmentView | ||
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 | usePlenaryShipmentView | ||
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 shipments 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 | getShipment | ||
Description |
Gets the | ||
Parameters | osid.id.Id | shipmentId | the Id of the Shipment to retrieve |
Return | osid.inventory.shipment.Shipment | the returned Shipment | |
Errors | NOT_FOUND | no Shipment found with the given Id | |
NULL_ARGUMENT | shipmentId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getShipmentsByIds | ||
Description |
Gets a | ||
Parameters | osid.id.IdList | shipmentIds | the list of Ids to retrieve |
Return | osid.inventory.shipment.ShipmentList | the returned ShipmentList list | |
Errors | NOT_FOUND | an Id was not found | |
NULL_ARGUMENT | shipmentIds is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getShipmentsByGenusType | ||
Description |
Gets a | ||
Parameters | osid.type.Type | shipmentGenusType | a shipment genus type |
Return | osid.inventory.shipment.ShipmentList | the returned ShipmentList list | |
Errors | NULL_ARGUMENT | shipmentGenusType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getShipmentsByParentGenusType | ||
Description |
Gets a In effective mode, shipments are returned that are currently effective. In any effective mode, effective shipments and those currently expired are returned. | ||
Parameters | osid.type.Type | shipmentGenusType | a shipment genus type |
Return | osid.inventory.shipment.ShipmentList | the returned ShipmentList list | |
Errors | NULL_ARGUMENT | shipmentGenusType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getShipmentsByRecordType | ||
Description |
Gets a In plenary mode, the returned list contains all known shipments or an error results. Otherwise, the returned list may contain only those shipments that are accessible through this session. | ||
Parameters | osid.type.Type | shipmentRecordType | a shipment record type |
Return | osid.inventory.shipment.ShipmentList | the returned ShipmentList list | |
Errors | NULL_ARGUMENT | shipmentRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getShipmentsOnDate | ||
Description |
Gets a In plenary mode, the returned list contains all known shipments or an error results. Otherwise, the returned list may contain only those shipments that are accessible through this session. | ||
Parameters | osid.calendaring.DateTime | from | starting date |
osid.calendaring.DateTime | to | ending date | |
Return | osid.inventory.shipment.ShipmentList | the returned ShipmentList list | |
Errors | INVALID_ARGUMENT | from is greater than to | |
NULL_ARGUMENT | from or to is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getShipmentsForStock | ||
Description |
Gets a In plenary mode, the returned list contains all known shipments or an error results. Otherwise, the returned list may contain only those shipments that are accessible through this session. | ||
Parameters | osid.id.Id | stockId | a stock Id |
Return | osid.inventory.shipment.ShipmentList | the returned ShipmentList 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 | getShipmentsForStockOnDate | ||
Description |
Gets a In plenary mode, the returned list contains all known shipments or an error results. Otherwise, the returned list may contain only those shipments that are accessible through this session. | ||
Parameters | osid.id.Id | stockId | a stock Id |
osid.calendaring.DateTime | from | starting date | |
osid.calendaring.DateTime | to | ending date | |
Return | osid.inventory.shipment.ShipmentList | the returned ShipmentList list | |
Errors | INVALID_ARGUMENT | from is greater than to | |
NULL_ARGUMENT | stockId, from, or to is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getShipmentsBySource | ||
Description |
Gets a In plenary mode, the returned list contains all known shipments or an error results. Otherwise, the returned list may contain only those shipments that are accessible through this session. | ||
Parameters | osid.id.Id | resourceId | a resource Id |
Return | osid.inventory.shipment.ShipmentList | the returned ShipmentList list | |
Errors | NULL_ARGUMENT | resourceId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getShipmentsBySourceOnDate | ||
Description |
Gets a In plenary mode, the returned list contains all known shipments or an error results. Otherwise, the returned list may contain only those shipments that are accessible through this session. | ||
Parameters | osid.id.Id | resourceId | a resource Id |
osid.calendaring.DateTime | from | starting date | |
osid.calendaring.DateTime | to | ending date | |
Return | osid.inventory.shipment.ShipmentList | the returned ShipmentList list | |
Errors | INVALID_ARGUMENT | from is greater than to | |
NULL_ARGUMENT | resourceId, from, or to is null
| ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getShipments | ||
Description |
Gets all | ||
Return | osid.inventory.shipment.ShipmentList | a list of Shipments | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |