org.osid.offering.rules

Interface CanonicalUnitEnablerNotificationSession

All Superinterfaces:

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

public interface CanonicalUnitEnablerNotificationSession
extends OsidSession

This session defines methods to receive notifications on adds/changes to CanonicalUnitEnabler objects in this Catalogue. This also includes existing CanonicalUnitEnablers that may appear or disappear due to changes in the Catalogue 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 CanonicalUnitEnablerLookupSession.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canRegisterForCanonicalUnitEnablerNotifications() Tests if this user can register for CanonicalUnitEnabler notifications.
Catalogue	getCatalogue() Gets the Catalogue associated with this session.
Id	getCatalogueId() Gets the Catalogue Id associated with this session.
void	registerForChangedCanonicalUnitEnabler(Id canonicalUnitEnablerId) Registers for notification of an updated canonical unit enabler.
void	registerForChangedCanonicalUnitEnablers() Registers for notification of updated canonical unit enablers.
void	registerForDeletedCanonicalUnitEnabler(Id canonicalUnitEnablerId) Registers for notification of a deleted canonical unit enabler.
void	registerForDeletedCanonicalUnitEnablers() Registers for notification of deleted canonical unit enablers.
void	registerForNewCanonicalUnitEnablers() Register for notifications of new canonical unit enablers.
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.

canRegisterForCanonicalUnitEnablerNotifications

boolean canRegisterForCanonicalUnitEnablerNotifications()

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

registerForNewCanonicalUnitEnablers

void registerForNewCanonicalUnitEnablers()
                                         throws OperationFailedException,
                                                PermissionDeniedException

Register for notifications of new canonical unit enablers. CanonicalUnitEnablerReceiver.newCanonicalUnitEnabler() is invoked when a new CanonicalUnitEnabler appears in this catalogue.

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForChangedCanonicalUnitEnablers

void registerForChangedCanonicalUnitEnablers()
                                             throws OperationFailedException,
                                                    PermissionDeniedException

Registers for notification of updated canonical unit enablers. CanonicalUnitEnablerReceiver.changedCanonicalUnitEnabler() is invoked when a canonical unit enabler in this catalogue is changed.

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForChangedCanonicalUnitEnabler

void registerForChangedCanonicalUnitEnabler(Id canonicalUnitEnablerId)
                                            throws OperationFailedException,
                                                   PermissionDeniedException

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

Parameters:

canonicalUnitEnablerId - the Id of the CanonicalUnitEnabler to monitor

Throws:

NullArgumentException - canonicalUnitEnablerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForDeletedCanonicalUnitEnablers

void registerForDeletedCanonicalUnitEnablers()
                                             throws OperationFailedException,
                                                    PermissionDeniedException

Registers for notification of deleted canonical unit enablers. CanonicalUnitEnablerReceiver.deletedCanonicalUnitEnabler() is invoked when a canonical unit enabler is deleted or removed from this catalogue.

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForDeletedCanonicalUnitEnabler

void registerForDeletedCanonicalUnitEnabler(Id canonicalUnitEnablerId)
                                            throws OperationFailedException,
                                                   PermissionDeniedException

Registers for notification of a deleted canonical unit enabler. CanonicalUnitEnablerReceiver.deletedCanonicalUnitEnabler() is invoked when the specified canonical unit enabler is deleted or removed from this catalogue.

Parameters:

canonicalUnitEnablerId - the Id of the CanonicalUnitEnabler to monitor

Throws:

NullArgumentException - canonicalUnitEnablerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.