org.osid.offering

Interface CanonicalUnitNotificationSession

All Superinterfaces:

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

public interface CanonicalUnitNotificationSession
extends OsidSession

This session defines methods to receive notifications on adds/changes to CanonicalUnit 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 session is closed.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canRegisterForCanonicalUnitNotifications() Tests if this user can register for CanonicalUnit notifications.
Catalogue	getCatalogue() Gets the Catalogue associated with this session.
Id	getCatalogueId() Gets the Catalogue Id associated with this session.
void	registerForChangedCanonicalUnit(Id canonicalUnitId) Registers for notification of an updated canonical unit.
void	registerForChangedCanonicalUnits() Registers for notification of updated canonical units.
void	registerForDeletedCanonicalUnit(Id canonicalUnitId) Registers for notification of a deleted canonical unit.
void	registerForDeletedCanonicalUnits() Registers for notification of deleted canonical units.
void	registerForNewCanonicalUnits() Register for notifications of new canonical units.
void	useFederatedCatalogueView() Federates the view for methods in this session.
void	useIsolatedCatalogueView() 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

getCatalogueId

Id getCatalogueId()

Gets the Catalogue Id associated with this session.

Returns:

the Catalogue Id associated with this session

Compliance:

mandatory - This method must be implemented.

getCatalogue

Catalogue getCatalogue()
                       throws OperationFailedException,
                              PermissionDeniedException

Gets the Catalogue associated with this session.

Returns:

the catalogue

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canRegisterForCanonicalUnitNotifications

boolean canRegisterForCanonicalUnitNotifications()

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

useFederatedCatalogueView

void useFederatedCatalogueView()

Federates the view for methods in this session. A federated view will include notifications for canonical unitss in catalogues which are children of this catalogue in the catalogue hierarchy.

Compliance:

mandatory - This method is must be implemented.

useIsolatedCatalogueView

void useIsolatedCatalogueView()

Isolates the view for methods in this session. An isolated view restricts notifications to this catalogue only.

Compliance:

mandatory - This method is must be implemented.

registerForNewCanonicalUnits

void registerForNewCanonicalUnits()
                                  throws OperationFailedException,
                                         PermissionDeniedException

Register for notifications of new canonical units. CanonicalUnitReceiver.newCanonicalUnits() is invoked when a new CanonicalUnit is created.

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForChangedCanonicalUnits

void registerForChangedCanonicalUnits()
                                      throws OperationFailedException,
                                             PermissionDeniedException

Registers for notification of updated canonical units. CanonicalUnitReceiver.changedCanonicalUnits() is invoked when a canonical unit in this catalogue is changed.

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForChangedCanonicalUnit

void registerForChangedCanonicalUnit(Id canonicalUnitId)
                                     throws NotFoundException,
                                            OperationFailedException,
                                            PermissionDeniedException

Registers for notification of an updated canonical unit. CanonicalUnitReceiver.changedCanonicalUnits() is invoked when the specified canonical unit in this catalogue is changed.

Parameters:

canonicalUnitId - the Id of the CanonicalUnit to monitor

Throws:

NotFoundException - a canonical unit was not found identified by the given Id

NullArgumentException - canonicalUnitId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForDeletedCanonicalUnits

void registerForDeletedCanonicalUnits()
                                      throws OperationFailedException,
                                             PermissionDeniedException

Registers for notification of deleted canonical units. CanonicalUnitReceiver.deletedCanonicalUnits() is invoked when a canonical unit is removed from this catalogue.

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForDeletedCanonicalUnit

void registerForDeletedCanonicalUnit(Id canonicalUnitId)
                                     throws NotFoundException,
                                            OperationFailedException,
                                            PermissionDeniedException

Registers for notification of a deleted canonical unit. CanonicalUnitReceiver.deletedCanonicalUnits() is invoked when the specified canonical unit is removed from this catalogue.

Parameters:

canonicalUnitId - the Id of the CanonicalUnit to monitor

Throws:

NotFoundException - a canonical unit was not found identified by the given Id

NullArgumentException - canonicalUnitId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.