OSID - osid.inventory.shipment.ShipmentLookupSession Service Interface Definition

Interface	osid.inventory.shipment.ShipmentLookupSession
Implements	`osid.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.`
Method	getWarehouseId
Description	Gets the `Warehouse` `Id` associated with this session.
Return	`osid.id.Id`		the `Warehouse Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getWarehouse
Description	Gets the `Warehouse` associated with this session.
Return	`osid.inventory.Warehouse`		the warehouse
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canLookupShipments
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.
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 `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.
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 `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.
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 `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.
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 `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.
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 `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.
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 `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.
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 `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.
Parameters	`osid.calendaring.DateTime`	`from`	starting date
Parameters	`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 `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.
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 `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.
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 `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.
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 `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.
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 `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.
Return	`osid.inventory.shipment.ShipmentList`		a list of `Shipments`
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.