org.osid.inventory

Interface ItemNotificationSession

All Superinterfaces:

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

public interface ItemNotificationSession
extends OsidSession

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.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canRegisterForItemNotifications() Tests if this user can register for Item notifications.
Warehouse	getWarehouse() Gets the Warehouse associated with this session.
Id	getWarehouseId() Gets the Warehouse Id associated with this session.
void	registerForChangedItem(Id itemId) Registers for notification of an updated item.
void	registerForChangedItems() Registers for notification of updated items.
void	registerForDeletedItem(Id itemId) Registers for notification of a deleted item.
void	registerForDeletedItems() Registers for notification of deleted items.
void	registerForNewItems() Register for notifications of new items.
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.

canRegisterForItemNotifications

boolean canRegisterForItemNotifications()

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.

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 items 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.

registerForNewItems

void registerForNewItems()
                         throws OperationFailedException,
                                PermissionDeniedException

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

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForChangedItems

void registerForChangedItems()
                             throws OperationFailedException,
                                    PermissionDeniedException

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

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForChangedItem

void registerForChangedItem(Id itemId)
                            throws OperationFailedException,
                                   PermissionDeniedException

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

Parameters:

itemId - the Id of the Item to monitor

Throws:

NullArgumentException - itemId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForDeletedItems

void registerForDeletedItems()
                             throws OperationFailedException,
                                    PermissionDeniedException

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

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForDeletedItem

void registerForDeletedItem(Id itemId)
                            throws OperationFailedException,
                                   PermissionDeniedException

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

Parameters:

itemId - the Id of the Item to monitor

Throws:

NullArgumentException - itemId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.