Interface | osid.inventory.ItemNotificationSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session defines methods to receive notifications on
adds/changes to The two views defined in this session correspond to the
views in the | ||
Method | getWarehouseId | ||
Description |
Gets the | ||
Return | osid.id.Id | the Warehouse Id associated with this session | |
Compliance | mandatory | This method must be implemented. | |
Method | getWarehouse | ||
Description |
Gets the | ||
Return | osid.inventory.Warehouse | the warehouse | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canRegisterForItemNotifications | ||
Description |
Tests if this user can register for | ||
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 items 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 | registerForNewItems | ||
Description |
Register for notifications of new items. | ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedItems | ||
Description |
Registers for notification of updated items. | ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedItem | ||
Description |
Registers for notification of an updated item. | ||
Parameters | osid.id.Id | itemId | the Id of the Item to monitor |
Errors | NULL_ARGUMENT | itemId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForDeletedItems | ||
Description |
Registers for notification of deleted items. | ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForDeletedItem | ||
Description |
Registers for notification of a deleted item. | ||
Parameters | osid.id.Id | itemId | the Id of the Item to monitor |
Errors | NULL_ARGUMENT | itemId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |