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
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.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canRegisterForWarehouseNotifications()
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. false
if notification methods are not
authorized, true
otherwisemandatory
- This method must be implemented. void registerForNewWarehouses() throws OperationFailedException, PermissionDeniedException
WarehouseReceiver.newWarehouses()
is invoked when a new
Warehouse
is created.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForNewWarehouseAncestors(Id warehouseId) throws OperationFailedException, PermissionDeniedException
WarehouseReceiver.newAncestorWarehous()
is invoked when the
specified warehouse experiences an addition in ancestry.warehouseId
- the Id
of the warehouse to monitorNullArgumentException
- warehouseId is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForNewWarehouseDescendants(Id warehouseId) throws OperationFailedException, PermissionDeniedException
WarehouseReceiver.newDescendantWarehouse()
is invoked when the
specified warehouse experiences an addition in descendants.warehouseId
- the Id
of the warehouse to monitorNullArgumentException
- warehouseId is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedWarehouses() throws OperationFailedException, PermissionDeniedException
WarehouseReceiver.changedWarehouses()
is invoked when a
warehouse is changed.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedWarehouse(Id warehouseId) throws OperationFailedException, PermissionDeniedException
WarehouseReceiver.changedWarehouses()
is invoked when the
specified warehouse is changed. SwarehouseId
- the Id of the Warehouse
to monitorNullArgumentException
- warehouseId is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedWarehouses() throws OperationFailedException, PermissionDeniedException
WarehouseReceiver.deletedWarehouses()
is invoked when a
warehouse is deleted.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedWarehouse(Id warehouseId) throws OperationFailedException, PermissionDeniedException
WarehouseReceiver.deletedWarehouses()
is invoked when the
specified warehouse is deleted.warehouseId
- the Id of the Warehouse
to monitorNullArgumentException
- warehouseId is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedWarehouseAncestors(Id warehouseId) throws OperationFailedException, PermissionDeniedException
WarehouseReceiver.deletedAncestorWarehouse()
is invoked when
the specified warehouse experiences a removal of an ancestor.warehouseId
- the Id
of the warehouse to monitorNullArgumentException
- warehouseId is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedWarehouseDescendants(Id warehouseId) throws OperationFailedException, PermissionDeniedException
WarehouseReceiver.deletedDescednantWarehouse()
is invoked when
the specified warehouse experiences a removal of one of its
descdendents.warehouseId
- the Id
of the warehouse to monitorNullArgumentException
- warehouseId is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.