OSID Logo
OSID Specifications
inventory shipment package
Version 3.0.0
Release Candidate Preview
Interfaceosid.inventory.shipment.ShipmentLookupSession
Implementsosid.OsidSession
Description

This session defines methods for retrieving shipments. A Shipment is a Resource related to the billing system.

This lookup session defines several views:

  • comparative view: elements may be silently omitted or re-ordered
  • plenary view: provides a complete result set or is an error condition
  • isolated warehouse view: All shipment methods in this session operate, retrieve and pertain to shipments defined explicitly in the current warehouse. Using an isolated view is useful for managing Shipments with the ShipmentAdminSession.
  • federated warehouse view: All shipment lookup methods in this session operate, retrieve and pertain to all shipments defined in this warehouse and any other shipments implicitly available in this warehouse through warehouse inheritence.

The methods useFederatedWarehouseView() and useIsolatedWarehouseView() behave as a radio group and one should be selected before invoking any lookup methods.

Shipments may have an additional records indicated by their respective record types. The record may not be accessed through a cast of the Shipment.

MethodgetWarehouseId
Description

Gets the Warehouse Id associated with this session.

Returnosid.id.Idthe Warehouse Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetWarehouse
Description

Gets the Warehouse associated with this session.

Returnosid.inventory.Warehousethe warehouse
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanLookupShipments
Description

Tests if this user can perform Shipment lookups. A return of true does not guarantee successful authorization. A return of false indicates that it is known all methods in this session will result in a PERMISSION_DENIED. This is intended as a hint to an application that may not offer lookup operations to unauthorized users.

Returnboolean false if lookup methods are not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoduseComparativeShipmentView
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.

CompliancemandatoryThis method is must be implemented.
MethodusePlenaryShipmentView
Description

A complete view of the Shipment returns is desired. Methods will return what is requested or result in an error. This view is used when greater precision is desired at the expense of interoperability.

CompliancemandatoryThis method is must be implemented.
MethoduseFederatedWarehouseView
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.

CompliancemandatoryThis method is must be implemented.
MethoduseIsolatedWarehouseView
Description

Isolates the view for methods in this session. An isolated view restricts retrievals to this warehouse only.

CompliancemandatoryThis method is must be implemented.
MethodgetShipment
Description

Gets the Shipment specified by its Id.

In plenary mode, the exact Id is found or a NOT_FOUND results. Otherwise, the returned Shipment may have a different Id than requested, such as the case where a duplicate Id was assigned to a Shipment and retained for compatibility.

Parametersosid.id.IdshipmentIdthe Id of the Shipment to retrieve
Returnosid.inventory.shipment.Shipmentthe returned Shipment
ErrorsNOT_FOUNDno Shipment found with the given Id
NULL_ARGUMENT shipmentId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetShipmentsByIds
Description

Gets a ShipmentList corresponding to the given IdList.

In plenary mode, the returned list contains all of the shipments specified in the Id list, in the order of the list, including duplicates, or an error results if an Id in the supplied list is not found or inaccessible. Otherwise, inaccessible Shipments may be omitted from the list and may present the elements in any order including returning a unique set.

Parametersosid.id.IdListshipmentIdsthe list of Ids to retrieve
Returnosid.inventory.shipment.ShipmentListthe returned ShipmentList list
ErrorsNOT_FOUNDan Id was not found
NULL_ARGUMENT shipmentIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetShipmentsByGenusType
Description

Gets a ShipmentList corresponding to the given shipment genus Type which does not include shipments of types derived from the specified Type.

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.

Parametersosid.type.TypeshipmentGenusTypea shipment genus type
Returnosid.inventory.shipment.ShipmentListthe returned ShipmentList list
ErrorsNULL_ARGUMENT shipmentGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetShipmentsByParentGenusType
Description

Gets a ShipmentList corresponding to the given shipment genus Type and include any additional shipments with genus types derived from the specified Type.

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.

In effective mode, shipments are returned that are currently effective. In any effective mode, effective shipments and those currently expired are returned.

Parametersosid.type.TypeshipmentGenusTypea shipment genus type
Returnosid.inventory.shipment.ShipmentListthe returned ShipmentList list
ErrorsNULL_ARGUMENT shipmentGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetShipmentsByRecordType
Description

Gets a ShipmentList containing the given shipment record Type.

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.

Parametersosid.type.TypeshipmentRecordTypea shipment record type
Returnosid.inventory.shipment.ShipmentListthe returned ShipmentList list
ErrorsNULL_ARGUMENT shipmentRecordType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetShipmentsOnDate
Description

Gets a ShipmentList received between the given date range inclusive.

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.

Parametersosid.calendaring.DateTimefromstarting date
osid.calendaring.DateTimetoending date
Returnosid.inventory.shipment.ShipmentListthe returned ShipmentList list
ErrorsINVALID_ARGUMENT from is greater than to
NULL_ARGUMENT from or to is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetShipmentsForStock
Description

Gets a ShipmentList for to the given stock.

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.

Parametersosid.id.IdstockIda stock Id
Returnosid.inventory.shipment.ShipmentListthe returned ShipmentList list
ErrorsNULL_ARGUMENT stockId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetShipmentsForStockOnDate
Description

Gets a ShipmentList for the given stock and received between the given date range inclusive .

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.

Parametersosid.id.IdstockIda stock Id
osid.calendaring.DateTimefromstarting date
osid.calendaring.DateTimetoending date
Returnosid.inventory.shipment.ShipmentListthe returned ShipmentList list
ErrorsINVALID_ARGUMENT from is greater than to
NULL_ARGUMENT stockId, from, or to is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetShipmentsBySource
Description

Gets a ShipmentList from to the given source.

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.

Parametersosid.id.IdresourceIda resource Id
Returnosid.inventory.shipment.ShipmentListthe returned ShipmentList list
ErrorsNULL_ARGUMENT resourceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetShipmentsBySourceOnDate
Description

Gets a ShipmentList from the given source and received between the given date range inclusive .

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.

Parametersosid.id.IdresourceIda resource Id
osid.calendaring.DateTimefromstarting date
osid.calendaring.DateTimetoending date
Returnosid.inventory.shipment.ShipmentListthe returned ShipmentList list
ErrorsINVALID_ARGUMENT from is greater than to
NULL_ARGUMENT resourceId, from, or to is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetShipments
Description

Gets all Shipments. 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.

Returnosid.inventory.shipment.ShipmentLista list of Shipments
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.