org.osid.inventory

Interface ModelNotificationSession

All Superinterfaces:

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

public interface ModelNotificationSession
extends OsidSession

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

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canRegisterForModelNotifications() Tests if this user can register for Model notifications.
Warehouse	getWarehouse() Gets the Warehouse associated with this session.
Id	getWarehouseId() Gets the Warehouse Id associated with this session.
void	registerForChangedModel(Id modelId) Registers for notification of an updated model.
void	registerForChangedModels() Registers for notification of updated models.
void	registerForDeletedModel(Id modelId) Registers for notification of a deleted model.
void	registerForDeletedModels() Registers for notification of deleted models.
void	registerForNewModels() Register for notifications of new models.
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.

canRegisterForModelNotifications

boolean canRegisterForModelNotifications()

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

registerForNewModels

void registerForNewModels()
                          throws OperationFailedException,
                                 PermissionDeniedException

Register for notifications of new models. ModelReceiver.newModels() is invoked when a new Model appears in this warehouse.

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForChangedModels

void registerForChangedModels()
                              throws OperationFailedException,
                                     PermissionDeniedException

Registers for notification of updated models. ModelReceiver.changedModels() is invoked when a model in this warehouse is changed.

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForChangedModel

void registerForChangedModel(Id modelId)
                             throws OperationFailedException,
                                    PermissionDeniedException

Registers for notification of an updated model. ModelReceiver.changedModels() is invoked when the specified model in this warehouse is changed.

Parameters:

modelId - the Id of the Model to monitor

Throws:

NullArgumentException - modelId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForDeletedModels

void registerForDeletedModels()
                              throws OperationFailedException,
                                     PermissionDeniedException

Registers for notification of deleted models. ModelReceiver.deletedModels() is invoked when a model is deleted or removed from this warehouse.

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForDeletedModel

void registerForDeletedModel(Id modelId)
                             throws OperationFailedException,
                                    PermissionDeniedException

Registers for notification of a deleted model. ModelReceiver.deletedModels() is invoked when the specified model is deleted or removed from this warehouse.

Parameters:

modelId - the Id of the Model to monitor

Throws:

NullArgumentException - modelId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.