public interface RelevancyEnablerNotificationSession extends OsidSession
This session defines methods to receive notifications on adds/changes
to RelevancyEnabler
objects in this Ontology.
This also includes existing RelevancyEnablers
that
may appear or disappear due to changes in the Ontology
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
RelevancyEnablerLookupSession.
Modifier and Type | Method and Description |
---|---|
void |
acknowledgeRelevancyEnablerNotification(Id notificationId)
Acknowledge a relevancy enabler notification.
|
boolean |
canRegisterForRelevancyEnablerNotifications()
Tests if this user can register for
RelevancyEnabler
notifications. |
Ontology |
getOntology()
Gets the
Ontology associated with this session. |
Id |
getOntologyId()
Gets the
Ontology Id associated with
this session. |
void |
registerForChangedRelevancyEnabler(Id relevancyEnablerId)
Registers for notification of an updated relevancy enabler.
|
void |
registerForChangedRelevancyEnablers()
Registers for notification of updated ontology enabelrs.
|
void |
registerForDeletedRelevancyEnabler(Id relevancyEnablerId)
Registers for notification of a deleted relevancy enabler.
|
void |
registerForDeletedRelevancyEnablers()
Registers for notification of deleted relevancy enablers.
|
void |
registerForNewRelevancyEnablers()
Register for notifications of new relevancy enablers.
|
void |
reliableRelevancyEnablerNotifications()
Reliable notifications are desired.
|
void |
unreliableRelevancyEnablerNotifications()
Unreliable notifications are desired.
|
void |
useFederatedOntologyView()
Federates the view for methods in this session.
|
void |
useIsolatedOntologyView()
Isolates the view for methods in this session.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getOntologyId()
Ontology
Id
associated with
this session. Ontology Id
associated with this sessionmandatory
- This method must be implemented. Ontology getOntology() throws OperationFailedException, PermissionDeniedException
Ontology
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canRegisterForRelevancyEnablerNotifications()
RelevancyEnabler
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 useFederatedOntologyView()
mandatory
- This method is must be implemented. void useIsolatedOntologyView()
mandatory
- This method is must be implemented. void reliableRelevancyEnablerNotifications()
acknowledgeRelevancyEnablerNotification()
.mandatory
- This method is must be implemented. void unreliableRelevancyEnablerNotifications()
mandatory
- This method is must be implemented. void acknowledgeRelevancyEnablerNotification(Id notificationId) throws OperationFailedException, PermissionDeniedException
notificationId
- the Id
of the notificationOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForNewRelevancyEnablers() throws OperationFailedException, PermissionDeniedException
RelevancyEnablerReceiver.newRelevancyEnablers()
is invoked
when a new RelevancyEnabler
appears in this ontology.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedRelevancyEnablers() throws OperationFailedException, PermissionDeniedException
RelevancyEnablerReceiver.changedRelevancyEnablers()
is invoked
when a relevancy enabler in this ontology is changed.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedRelevancyEnabler(Id relevancyEnablerId) throws OperationFailedException, PermissionDeniedException
ProvisionableReceiver.changedRelevancyEnablers()
is invoked
when the specified relevancy enabler in this ontology is changed.relevancyEnablerId
- the Id
of the
RelevancyEnabler
to monitorNullArgumentException
- relevancyEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedRelevancyEnablers() throws OperationFailedException, PermissionDeniedException
RelevancyEnablerReceiver.deletedRelevancyEnablers()
is invoked
when a relevancy enabler is deleted or removed from this ontology.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedRelevancyEnabler(Id relevancyEnablerId) throws OperationFailedException, PermissionDeniedException
RelevancyEnablerReceiver.deletedRelevancyEnablers()
is invoked
when the specified relevancy enabler is deleted or removed from this
ontology.relevancyEnablerId
- the Id
of the
RelevancyEnabler
to monitorNullArgumentException
- relevancyEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.