public interface ShipmentLookupSession extends OsidSession
This session defines methods for retrieving shipments. A
Shipment
is a Resource
related to the billing
system.
This lookup session defines several views:
Shipments
with the ShipmentAdminSession.
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.
Modifier and Type | Method and Description |
---|---|
boolean |
canLookupShipments()
Tests if this user can perform
Shipment lookups. |
Shipment |
getShipment(Id shipmentId)
Gets the
Shipment specified by its Id. |
ShipmentList |
getShipments()
Gets all
Shipments. |
ShipmentList |
getShipmentsByGenusType(Type shipmentGenusType)
Gets a
ShipmentList corresponding to the given shipment
genus Type which does not include shipments of types
derived from the specified Type. |
ShipmentList |
getShipmentsByIds(IdList shipmentIds)
Gets a
ShipmentList corresponding to the given
IdList. |
ShipmentList |
getShipmentsByParentGenusType(Type shipmentGenusType)
Gets a
ShipmentList corresponding to the given shipment
genus Type and include any additional shipments with
genus types derived from the specified Type. |
ShipmentList |
getShipmentsByRecordType(Type shipmentRecordType)
Gets a
ShipmentList containing the given shipment
record Type. |
ShipmentList |
getShipmentsBySource(Id resourceId)
Gets a
ShipmentList from to the given source. |
ShipmentList |
getShipmentsBySourceOnDate(Id resourceId,
DateTime from,
DateTime to)
Gets a
ShipmentList from the given source and received
between the given date range inclusive . |
ShipmentList |
getShipmentsForStock(Id stockId)
Gets a
ShipmentList for to the given stock. |
ShipmentList |
getShipmentsForStockOnDate(Id stockId,
DateTime from,
DateTime to)
Gets a
ShipmentList for the given stock and received
between the given date range inclusive . |
ShipmentList |
getShipmentsOnDate(DateTime from,
DateTime to)
Gets a
ShipmentList received between the given date
range inclusive. |
Warehouse |
getWarehouse()
Gets the
Warehouse associated with this session. |
Id |
getWarehouseId()
Gets the
Warehouse Id associated with
this session. |
void |
useComparativeShipmentView()
The returns from the lookup methods may omit or translate elements
based on this session, such as authorization, and not result in an
error.
|
void |
useFederatedWarehouseView()
Federates the view for methods in this session.
|
void |
useIsolatedWarehouseView()
Isolates the view for methods in this session.
|
void |
usePlenaryShipmentView()
A complete view of the
Shipment returns is desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getWarehouseId()
Warehouse
Id
associated with
this session. Warehouse Id
associated with this sessionmandatory
- This method must be implemented. Warehouse getWarehouse() throws OperationFailedException, PermissionDeniedException
Warehouse
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canLookupShipments()
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. false
if lookup methods are not authorized,
true
otherwisemandatory
- This method must be implemented. void useComparativeShipmentView()
mandatory
- This method is must be implemented. void usePlenaryShipmentView()
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.mandatory
- This method is must be implemented. void useFederatedWarehouseView()
mandatory
- This method is must be implemented. void useIsolatedWarehouseView()
mandatory
- This method is must be implemented. Shipment getShipment(Id shipmentId) throws NotFoundException, OperationFailedException, PermissionDeniedException
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.shipmentId
- the Id
of the Shipment
to retrieve Shipment
NotFoundException
- no Shipment
found
with the given Id
NullArgumentException
- shipmentId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ShipmentList getShipmentsByIds(IdList shipmentIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
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.shipmentIds
- the list of Ids
to retrieve ShipmentList
listNotFoundException
- an Id was
not foundNullArgumentException
- shipmentIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ShipmentList getShipmentsByGenusType(Type shipmentGenusType) throws OperationFailedException, PermissionDeniedException
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.shipmentGenusType
- a shipment genus type ShipmentList
listNullArgumentException
- shipmentGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ShipmentList getShipmentsByParentGenusType(Type shipmentGenusType) throws OperationFailedException, PermissionDeniedException
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.shipmentGenusType
- a shipment genus type ShipmentList
listNullArgumentException
- shipmentGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ShipmentList getShipmentsByRecordType(Type shipmentRecordType) throws OperationFailedException, PermissionDeniedException
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.shipmentRecordType
- a shipment record type ShipmentList
listNullArgumentException
- shipmentRecordType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ShipmentList getShipmentsOnDate(DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
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.from
- starting dateto
- ending date ShipmentList
listInvalidArgumentException
- from
is
greater than to
NullArgumentException
- from
or
to
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ShipmentList getShipmentsForStock(Id stockId) throws OperationFailedException, PermissionDeniedException
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.stockId
- a stock Id
ShipmentList
listNullArgumentException
- stockId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ShipmentList getShipmentsForStockOnDate(Id stockId, DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
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.stockId
- a stock Id
from
- starting dateto
- ending date ShipmentList
listInvalidArgumentException
- from
is
greater than to
NullArgumentException
- stockId, from,
or to
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ShipmentList getShipmentsBySource(Id resourceId) throws OperationFailedException, PermissionDeniedException
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.resourceId
- a resource Id
ShipmentList
listNullArgumentException
- resourceId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ShipmentList getShipmentsBySourceOnDate(Id resourceId, DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
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.resourceId
- a resource Id
from
- starting dateto
- ending date ShipmentList
listInvalidArgumentException
- from
is
greater than to
NullArgumentException
- resourceId, from,
or to
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ShipmentList getShipments() throws OperationFailedException, PermissionDeniedException
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. Shipments
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.