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

This session defines methods to receive notifications on adds/changes to Item objects in this Warehouse. This also includes existing items 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 ItemLookupSession.

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.
MethodcanRegisterForItemNotifications
Description

Tests if this user can register for Item 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.

Returnboolean false if notification methods are not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoduseFederatedWarehouseView
Description

Federates the view for methods in this session. A federated view will include items 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 notifications to this warehouse only.

CompliancemandatoryThis method is must be implemented.
MethodregisterForNewItems
Description

Register for notifications of new items. ItemReceiver.newItems() is invoked when a new Item appears in this warehouse.

ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedItems
Description

Registers for notification of updated items. ItemReceiver.changedItems() is invoked when an item in this warehouse is changed.

ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedItem
Description

Registers for notification of an updated item. ItemReceiver.changedItems() is invoked when the specified item in this warehouse is changed.

Parametersosid.id.IditemIdthe Id of the Item to monitor
ErrorsNULL_ARGUMENT itemId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedItems
Description

Registers for notification of deleted items. ItemReceiver.deletedItems() is invoked when an item is deleted or removed from this warehouse.

ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedItem
Description

Registers for notification of a deleted item. ItemReceiver.deletedItems() is invoked when the specified item is deleted or removed from this warehouse.

Parametersosid.id.IditemIdthe Id of the Item to monitor
ErrorsNULL_ARGUMENT itemId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.