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

Interface	osid.inventory.shipment.ShipmentNotificationSession
Implements	`osid.OsidSession`
Description	This session defines methods to receive notifications on adds/changes to `Shipment` objects in this `Warehouse.` This also includes existing shipments that may appear or disappear due to changes in the `Warehouse` hierarchy, This session is intended for consumers needing to synchronize their state with this service without the use of polling. Notifications are cancelled when this session is closed. The two views defined in this session correspond to the views in the `ShipmentLookupSession.`
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	canRegisterForShipmentNotifications
Description	Tests if this user can register for `Shipment` notifications. 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 opt not to offer notification operations.
Return	`boolean`		`false` if notification methods are not authorized, `true` otherwise
Compliance	`mandatory`		This method 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 notifications to this warehouse only.
Compliance	`mandatory`		This method is must be implemented.
Method	reliableShipmentNotifications
Description	Reliable notifications are desired. In reliable mode, notifications are to be acknowledged using `acknowledgeShipmentNotification()` .
Compliance	`mandatory`		This method is must be implemented.
Method	unreliableShipmentNotifications
Description	Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged.
Compliance	`mandatory`		This method is must be implemented.
Method	acknowledgeShipmentNotification
Description	Acknowledge a shipment notification.
Parameters	`osid.id.Id`	`notificationId`	the `Id` of the notification
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForNewShipments
Description	Register for notifications of new shipments. `ShipmentReceiver.newShipments()` is invoked when a new `Shipment` appears in this warehouse.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForNewShipmentsForSource
Description	Register for notifications of new shipments for the given source. `ShipmentReceiver.newShipments()` is invoked when a new `Shipment` appears in this warehouse.
Parameters	`osid.id.Id`	`sourceId`	the `Id` of the source to monitor
Errors	NULL_ARGUMENT		`sourceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForNewShipmentsForStock
Description	Register for notifications of new shipments for the given stock. `ShipmentReceiver.newShipments()` is invoked when a new `Shipment` appears in this warehouse.
Parameters	`osid.id.Id`	`stockId`	the `Id` of the `Stock` to monitor
Errors	NULL_ARGUMENT		`stockId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedShipments
Description	Registers for notification of updated shipments. `ShipmentReceiver.changedShipments()` is invoked when a shipment in this warehouse is changed.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedShipmentsForSource
Description	Registers for notification of updated shipments for the given source. `ShipmentReceiver.changedShipments()` is invoked when the specified shipment in this warehouse is changed.
Parameters	`osid.id.Id`	`sourceId`	the `Id` of the source to monitor
Errors	NULL_ARGUMENT		`sourceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedShipmentsForStock
Description	Registers for notification of updated shipments for the given stock. `ShipmentReceiver.changedShipments()` is invoked when the specified shipment in this warehouse is changed.
Parameters	`osid.id.Id`	`stockId`	the `Id` of the `Stock` to monitor
Errors	NULL_ARGUMENT		`stockId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedShipment
Description	Registers for notification of an updated shipment. `ShipmentReceiver.changedShipments()` is invoked when the specified shipment in this warehouse is changed.
Parameters	`osid.id.Id`	`shipmentId`	the `Id` of the `Shipment` to monitor
Errors	NULL_ARGUMENT		`shipmentId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedShipments
Description	Registers for notification of deleted shipments. `ShipmentReceiver.deletedShipments()` is invoked when a shipment is deleted or removed from this warehouse.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedShipmentsForSource
Description	Registers for notification of deleted shipments for the given source. `ShipmentReceiver.deletedShipments()` is invoked when the specified shipment is deleted or removed from this warehouse.
Parameters	`osid.id.Id`	`sourceId`	the `Id` of the source to monitor
Errors	NULL_ARGUMENT		`sourceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedShipmentsForStock
Description	Registers for notification of deleted shipments for the given stock. `ShipmentReceiver.deletedShipments()` is invoked when the specified shipment is deleted or removed from this warehouse.
Parameters	`osid.id.Id`	`stockId`	the `Id` of the `Stock` to monitor
Errors	NULL_ARGUMENT		`stockId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedShipment
Description	Registers for notification of a deleted shipment. `ShipmentReceiver.deletedShipments()` is invoked when the specified shipment is deleted or removed from this warehouse.
Parameters	`osid.id.Id`	`shipmentId`	the `Id` of the `Shipment` to monitor
Errors	NULL_ARGUMENT		`shipmentId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.