org.osid.inventory

Interface WarehouseNotificationSession

All Superinterfaces:

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

public interface WarehouseNotificationSession
extends OsidSession

This session defines methods to receive notifications on adds/changes to Warehouse objects. This session is intended for consumers needing to synchronize their state with this service without the use of polling. Notifications are cancelled when this sess

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canRegisterForWarehouseNotifications() Tests if this user can register for Warehouse notifications.
void	registerForChangedWarehouse(Id warehouseId) Registers for notification of an updated warehouse.
void	registerForChangedWarehouses() Registers for notification of updated warehouses.
void	registerForDeletedWarehouse(Id warehouseId) Registers for notification of a deleted warehouse.
void	registerForDeletedWarehouseAncestors(Id warehouseId) Registers for notification if an ancestor is removed from the specified warehouse in the warehouse hierarchy.
void	registerForDeletedWarehouseDescendants(Id warehouseId) Registers for notification if a descendant is removed from fthe specified warehouse in the warehouse hierarchy.
void	registerForDeletedWarehouses() Registers for notification of deleted warehouses.
void	registerForNewWarehouseAncestors(Id warehouseId) Registers for notification if an ancestor is added to the specified warehouse in the warehouse hierarchy.
void	registerForNewWarehouseDescendants(Id warehouseId) Registers for notification if a descendant is added to the specified warehouse in the warehouse hierarchy.
void	registerForNewWarehouses() Register for notifications of new warehouses.

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

canRegisterForWarehouseNotifications

boolean canRegisterForWarehouseNotifications()

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

registerForNewWarehouses

void registerForNewWarehouses()
                              throws OperationFailedException,
                                     PermissionDeniedException

Register for notifications of new warehouses. WarehouseReceiver.newWarehouses() is invoked when a new Warehouse is created.

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForNewWarehouseAncestors

void registerForNewWarehouseAncestors(Id warehouseId)
                                      throws OperationFailedException,
                                             PermissionDeniedException

Registers for notification if an ancestor is added to the specified warehouse in the warehouse hierarchy. WarehouseReceiver.newAncestorWarehous() is invoked when the specified warehouse experiences an addition in ancestry.

Parameters:

warehouseId - the Id of the warehouse to monitor

Throws:

NullArgumentException - warehouseId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForNewWarehouseDescendants

void registerForNewWarehouseDescendants(Id warehouseId)
                                        throws OperationFailedException,
                                               PermissionDeniedException

Registers for notification if a descendant is added to the specified warehouse in the warehouse hierarchy. WarehouseReceiver.newDescendantWarehouse() is invoked when the specified warehouse experiences an addition in descendants.

Parameters:

warehouseId - the Id of the warehouse to monitor

Throws:

NullArgumentException - warehouseId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForChangedWarehouses

void registerForChangedWarehouses()
                                  throws OperationFailedException,
                                         PermissionDeniedException

Registers for notification of updated warehouses. WarehouseReceiver.changedWarehouses() is invoked when a warehouse is changed.

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForChangedWarehouse

void registerForChangedWarehouse(Id warehouseId)
                                 throws OperationFailedException,
                                        PermissionDeniedException

Registers for notification of an updated warehouse. WarehouseReceiver.changedWarehouses() is invoked when the specified warehouse is changed. S

Parameters:

warehouseId - the Id of the Warehouse to monitor

Throws:

NullArgumentException - warehouseId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForDeletedWarehouses

void registerForDeletedWarehouses()
                                  throws OperationFailedException,
                                         PermissionDeniedException

Registers for notification of deleted warehouses. WarehouseReceiver.deletedWarehouses() is invoked when a warehouse is deleted.

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForDeletedWarehouse

void registerForDeletedWarehouse(Id warehouseId)
                                 throws OperationFailedException,
                                        PermissionDeniedException

Registers for notification of a deleted warehouse. WarehouseReceiver.deletedWarehouses() is invoked when the specified warehouse is deleted.

Parameters:

warehouseId - the Id of the Warehouse to monitor

Throws:

NullArgumentException - warehouseId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForDeletedWarehouseAncestors

void registerForDeletedWarehouseAncestors(Id warehouseId)
                                          throws OperationFailedException,
                                                 PermissionDeniedException

Registers for notification if an ancestor is removed from the specified warehouse in the warehouse hierarchy. WarehouseReceiver.deletedAncestorWarehouse() is invoked when the specified warehouse experiences a removal of an ancestor.

Parameters:

warehouseId - the Id of the warehouse to monitor

Throws:

NullArgumentException - warehouseId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForDeletedWarehouseDescendants

void registerForDeletedWarehouseDescendants(Id warehouseId)
                                            throws OperationFailedException,
                                                   PermissionDeniedException

Registers for notification if a descendant is removed from fthe specified warehouse in the warehouse hierarchy. WarehouseReceiver.deletedDescednantWarehouse() is invoked when the specified warehouse experiences a removal of one of its descdendents.

Parameters:

warehouseId - the Id of the warehouse to monitor

Throws:

NullArgumentException - warehouseId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.