org.osid.inventory

Interface InventoryNotificationSession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidSession

public interface InventoryNotificationSession
extends OsidSession

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

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canRegisterForInventoryNotifications() Tests if this user can register for Inventory notifications.
Warehouse	getWarehouse() Gets the Warehouse associated with this session.
Id	getWarehouseId() Gets the Warehouse Id associated with this session.
void	registerForChangedInventories() Registers for notification of updated inventories.
void	registerForChangedInventoriesForStock(Id stockId) Registers for notification of updated inventories for the given stock.
void	registerForChangedInventory(Id inventoryId) Registers for notification of an updated inventory.
void	registerForDeletedInventories() Registers for notification of deleted inventories.
void	registerForDeletedInventoriesForStock(Id stockId) Registers for notification of deleted inventories for the given stock.
void	registerForDeletedInventory(Id inventoryId) Registers for notification of a deleted inventory.
void	registerForNewInventories() Register for notifications of new inventories.
void	registerForNewInventoriesForStock(Id stockId) Register for notifications of new inventories for the given stock.
void	useFederatedWarehouseView() Federates the view for methods in this session.
void	useIsolatedWarehouseView() Isolates the view for methods in this session.

Methods inherited from interface org.osid.OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Methods inherited from interface org.osid.binding.java.OsidSession

close

Methods inherited from interface java.io.Closeable

close

Method Detail

getWarehouseId

Id getWarehouseId()

Gets the Warehouse Id associated with this session.

Returns:

the Warehouse Id associated with this session

Compliance:

mandatory - This method must be implemented.

getWarehouse

Warehouse getWarehouse()
                       throws OperationFailedException,
                              PermissionDeniedException

Gets the Warehouse associated with this session.

Returns:

the warehouse

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canRegisterForInventoryNotifications

boolean canRegisterForInventoryNotifications()

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

Returns:

false if notification methods are not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

useFederatedWarehouseView

void useFederatedWarehouseView()

Federates the view for methods in this session. A federated view will include inventories in catalogs which are children of this catalog in the warehouse hierarchy.

Compliance:

mandatory - This method is must be implemented.

useIsolatedWarehouseView

void useIsolatedWarehouseView()

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.

registerForNewInventories

void registerForNewInventories()
                               throws OperationFailedException,
                                      PermissionDeniedException

Register for notifications of new inventories. InventoryReceiver.newInventories() is invoked when a new Inventory appears in this warehouse.

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForNewInventoriesForStock

void registerForNewInventoriesForStock(Id stockId)
                                       throws OperationFailedException,
                                              PermissionDeniedException

Register for notifications of new inventories for the given stock. InventoryReceiver.newInventories() is invoked when a new Inventory appears in this warehouse.

Parameters:

stockId - the Id of the Stock to monitor

Throws:

NullArgumentException - stock is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForChangedInventories

void registerForChangedInventories()
                                   throws OperationFailedException,
                                          PermissionDeniedException

Registers for notification of updated inventories. InventoryReceiver.changedInventories() is invoked when an inventory in this warehouse is changed.

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForChangedInventoriesForStock

void registerForChangedInventoriesForStock(Id stockId)
                                           throws OperationFailedException,
                                                  PermissionDeniedException

Registers for notification of updated inventories for the given stock. InventoryReceiver.changedInventories() is invoked when an inventory in this warehouse is changed.

Parameters:

stockId - the Id of the Stock to monitor

Throws:

NullArgumentException - stock is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForChangedInventory

void registerForChangedInventory(Id inventoryId)
                                 throws OperationFailedException,
                                        PermissionDeniedException

Registers for notification of an updated inventory. InventoryReceiver.changedInventories() is invoked when the specified inventory in this warehouse is changed.

Parameters:

inventoryId - the Id of the Inventory to monitor

Throws:

NullArgumentException - inventoryId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForDeletedInventories

void registerForDeletedInventories()
                                   throws OperationFailedException,
                                          PermissionDeniedException

Registers for notification of deleted inventories. InventoryReceiver.deletedInventories() is invoked when an inventory is deleted or removed from this warehouse.

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForDeletedInventoriesForStock

void registerForDeletedInventoriesForStock(Id stockId)
                                           throws OperationFailedException,
                                                  PermissionDeniedException

Registers for notification of deleted inventories for the given stock. InventoryReceiver.deletedInventories() is invoked when an inventory is deleted or removed from this warehouse.

Parameters:

stockId - the Id of the Stock to monitor

Throws:

NullArgumentException - stock is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForDeletedInventory

void registerForDeletedInventory(Id inventoryId)
                                 throws OperationFailedException,
                                        PermissionDeniedException

Registers for notification of a deleted inventory. InventoryReceiver.deletedInventories() is invoked when the specified inventory is deleted or removed from this warehouse.

Parameters:

inventoryId - the Id of the Inventory to monitor

Throws:

NullArgumentException - inventoryId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.