public interface CanonicalUnitProcessorEnablerNotificationSession extends OsidSession
This session defines methods to receive notifications on adds/changes
to CanonicalUnitProcessorEnabler
objects in this
Catalogue.
This also includes existing
CanonicalUnitProcessorEnablers
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
CanonicalUnitProcessorEnablerLookupSession.
Modifier and Type | Method and Description |
---|---|
void |
acknowledgeCanonicalUnitProcessorEnablerNotification(Id notificationId)
Acknowledge a caninical unit processor enabler notification.
|
boolean |
canRegisterForCanonicalUnitProcessorEnablerNotifications()
Tests if this user can register for
CanonicalUnitProcessorEnabler notifications. |
Catalogue |
getCatalogue()
Gets the
Catalogue associated with this session. |
Id |
getCatalogueId()
Gets the
Catalogue Id associated with
this session. |
void |
registerForChangedCanonicalUnitProcessorEnabler(Id canonicalUnitProcessorEnablerId)
Registers for notification of an updated canonical unit processor
enabler.
|
void |
registerForChangedCanonicalUnitProcessorEnablers()
Registers for notification of updated catalogue enablers.
|
void |
registerForDeletedCanonicalUnitProcessorEnabler(Id canonicalUnitProcessorEnablerId)
Registers for notification of a deleted canonical unit processor
enabler.
|
void |
registerForDeletedCanonicalUnitProcessorEnablers()
Registers for notification of deleted canonical unit processor
enablers.
|
void |
registerForNewCanonicalUnitProcessorEnablers()
Register for notifications of new canonical unit processor enablers.
|
void |
reliableCanonicalUnitProcessorEnablerNotifications()
Reliable notifications are desired.
|
void |
unreliableCanonicalUnitProcessorEnablerNotifications()
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 canRegisterForCanonicalUnitProcessorEnablerNotifications()
CanonicalUnitProcessorEnabler
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 reliableCanonicalUnitProcessorEnablerNotifications()
acknowledgeCanonicalUnitProcessorEnablerNotification()
.mandatory
- This method is must be implemented. void unreliableCanonicalUnitProcessorEnablerNotifications()
mandatory
- This method is must be implemented. void acknowledgeCanonicalUnitProcessorEnablerNotification(Id notificationId) throws OperationFailedException, PermissionDeniedException
notificationId
- the Id
of the notificationOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForNewCanonicalUnitProcessorEnablers() throws OperationFailedException, PermissionDeniedException
CanonicalUnitProcessorEnablerReceiver.newCanonicalUnitProcessorEnablers()
is invoked when a new CanonicalUnitProcessorEnabler
appears in this catalogue.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedCanonicalUnitProcessorEnablers() throws OperationFailedException, PermissionDeniedException
CanonicalUnitProcessorEnablerReceiver.changedCanonicalUnitProcessorEnablers()
is invoked when a canonical unit processor enabler in this
catalogue is changed.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedCanonicalUnitProcessorEnabler(Id canonicalUnitProcessorEnablerId) throws OperationFailedException, PermissionDeniedException
ProvisionableReceiver.changedCanonicalUnitProcessorEnablers()
is invoked when the specified canonical unit processor enabler in this
catalogue is changed.canonicalUnitProcessorEnablerId
- the Id
of the
CanonicalUnitProcessorEnabler
to monitorNullArgumentException
-
canonicalUnitProcessorEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedCanonicalUnitProcessorEnablers() throws OperationFailedException, PermissionDeniedException
CanonicalUnitProcessorEnablerReceiver.deletedCanonicalUnitProcessorEnablers()
is invoked when a canonical unit processor enabler is deleted
or removed from this catalogue.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedCanonicalUnitProcessorEnabler(Id canonicalUnitProcessorEnablerId) throws OperationFailedException, PermissionDeniedException
CanonicalUnitProcessorEnablerReceiver.deletedCanonicalUnitProcessorEnablers()
is invoked when the specified canonical unit processor enabler
is deleted or removed from this catalogue.canonicalUnitProcessorEnablerId
- the Id
of the
CanonicalUnitProcessorEnabler
to monitorNullArgumentException
-
canonicalUnitProcessorEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.