public interface CanonicalUnitProcessorNotificationSession extends OsidSession
This session defines methods to receive notifications on adds/changes
to CanonicalUnitProcessor
objects in this Catalogue.
This also includes existing CanonicalUnitProcessors
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
CanonicalUnitProcessorLookupSession.
Modifier and Type | Method and Description |
---|---|
void |
acknowledgeCanonicalUnitProcessorNotification(Id notificationId)
Acknowledge a canonical unit processor notification.
|
boolean |
canRegisterForCanonicalUnitProcessorNotifications()
Tests if this user can register for
CanonicalUnitProcessor
notifications. |
Catalogue |
getCatalogue()
Gets the
Catalogue associated with this session. |
Id |
getCatalogueId()
Gets the
Catalogue Id associated with
this session. |
void |
registerForChangedCanonicalUnitProcessor(Id canonicalUnitProcessorId)
Registers for notification of an updated canonical unit processor.
|
void |
registerForChangedCanonicalUnitProcessors()
Registers for notification of updated catalogues.
|
void |
registerForDeletedCanonicalUnitProcessor(Id canonicalUnitProcessorId)
Registers for notification of a deleted canonical unit processor.
|
void |
registerForDeletedCanonicalUnitProcessors()
Registers for notification of deleted canonical unit processors.
|
void |
registerForNewCanonicalUnitProcessors()
Register for notifications of new canonical unit processors.
|
void |
reliableCanonicalUnitProcessorNotifications()
Reliable notifications are desired.
|
void |
unreliableCanonicalUnitProcessorNotifications()
Unreliable notifications are desired.
|
void |
useFederatedCatalogueView()
Federates the view for methods in this session.
|
void |
useIsolatedCatalogueView()
Isolates the view for methods in this session.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getCatalogueId()
Catalogue
Id
associated with
this session. Catalogue Id
associated with this sessionmandatory
- This method must be implemented. Catalogue getCatalogue() throws OperationFailedException, PermissionDeniedException
Catalogue
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canRegisterForCanonicalUnitProcessorNotifications()
CanonicalUnitProcessor
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 useFederatedCatalogueView()
mandatory
- This method is must be implemented. void useIsolatedCatalogueView()
mandatory
- This method is must be implemented. void reliableCanonicalUnitProcessorNotifications()
acknowledgeCanonicalUnitProcessorNotification()
.mandatory
- This method is must be implemented. void unreliableCanonicalUnitProcessorNotifications()
mandatory
- This method is must be implemented. void acknowledgeCanonicalUnitProcessorNotification(Id notificationId) throws OperationFailedException, PermissionDeniedException
notificationId
- the Id
of the notificationOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForNewCanonicalUnitProcessors() throws OperationFailedException, PermissionDeniedException
CanonicalUnitProcessorReceiver.newCanonicalUnitProcessors()
is
invoked when a new CanonicalUnitProcessor
appears in
this catalogue.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedCanonicalUnitProcessors() throws OperationFailedException, PermissionDeniedException
CanonicalUnitProcessorReceiver.changedCanonicalUnitProcessors()
is invoked when a canonical unit processor in this catalogue
is changed.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedCanonicalUnitProcessor(Id canonicalUnitProcessorId) throws OperationFailedException, PermissionDeniedException
ProvisionableReceiver.changedCanonicalUnitProcessors()
is invoked when the specified canonical unit processor in this
catalogue is changed.canonicalUnitProcessorId
- the Id
of the
CanonicalUnitProcessor
to monitorNullArgumentException
- canonicalUnitProcessorId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedCanonicalUnitProcessors() throws OperationFailedException, PermissionDeniedException
CanonicalUnitProcessorReceiver.deletedCanonicalUnitProcessors()
is invoked when a canonical unit processor is deleted or
removed from this catalogue.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedCanonicalUnitProcessor(Id canonicalUnitProcessorId) throws OperationFailedException, PermissionDeniedException
CanonicalUnitProcessorReceiver.deletedCanonicalUnitProcessors()
is invoked when the specified canonical unit processor is
deleted or removed from this catalogue.canonicalUnitProcessorId
- the Id
of the
CanonicalUnitProcessor
to monitorNullArgumentException
- canonicalUnitProcessorId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.