public interface RelevancyNotificationSession extends OsidSession
This session defines methods to receive asynchronous notifications on adds/changes to subject relevancies. 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 views defined in this session correspond to the views in the
RelevancyLookupSession.
Modifier and Type | Method and Description |
---|---|
void |
acknowledgeRelevancyNotification(Id notificationId)
Acknowledge a relevancy notification.
|
boolean |
canRegisterForRelevancyNotifications()
Tests if this user can register for
Relevancy
notifications. |
Ontology |
getOntology()
Gets the
Ontology associated with this session. |
Id |
getOntologyId()
Gets the
Ontology Id associated with
this session. |
void |
registerForChangedRelevancies()
Registers for notification of updated relevancies.
|
void |
registerForChangedRelevanciesByGenusType(Type relevancyGenusType)
Register for notifications of changed relevancies of the given genus
type.
|
void |
registerForChangedRelevanciesForId(Id id)
Register for notifications of changed relevancies for the given
Id. |
void |
registerForChangedRelevanciesForSubject(Id subjectId)
Register for notifications of changed relevancies for the given
subject.
|
void |
registerForChangedRelevancy(Id relevancyId)
Registers for notification of an updated relevancy.
|
void |
registerForDeletedRelevancies()
Registers for notification of deleted relevancies.
|
void |
registerForDeletedRelevanciesByGenusType(Type relevancyGenusType)
Register for notifications of deleted relevancies of the given genus
type.
|
void |
registerForDeletedRelevanciesForId(Id id)
Register for notifications of deleted relevancies for the given
Id. |
void |
registerForDeletedRelevanciesForSubject(Id subjectId)
Register for notifications of deleted relevancies for the given
subject.
|
void |
registerForDeletedRelevancy(Id relevancyId)
Registers for notification of a deleted relevancy.
|
void |
registerForNewRelevancies()
Register for notifications of new relevancies.
|
void |
registerForNewRelevanciesByGenusType(Type relevancyGenusType)
Register for notifications of new relevancies by the given genus type.
|
void |
registerForNewRelevanciesForId(Id id)
Register for notifications of new relevancies for the given mapped
Id. |
void |
registerForNewRelevanciesForSubject(Id subjectId)
Register for notifications of new relevancies for the given subject.
|
void |
reliableRelevancyNotifications()
Reliable notifications are desired.
|
void |
unreliableRelevancyNotifications()
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. Ontology
associated with this sessionOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canRegisterForRelevancyNotifications()
Relevancy
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 reliableRelevancyNotifications()
acknowledgeRelevancyNotification()
.mandatory
- This method is must be implemented. void unreliableRelevancyNotifications()
mandatory
- This method is must be implemented. void acknowledgeRelevancyNotification(Id notificationId) throws OperationFailedException, PermissionDeniedException
notificationId
- the Id
of the notificationOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForNewRelevancies() throws OperationFailedException, PermissionDeniedException
RelevancyReceiver.newRelevancies()
is invoked when a new
relevancy is created.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForNewRelevanciesByGenusType(Type relevancyGenusType) throws OperationFailedException, PermissionDeniedException
RelevancyReceiver.newRelevancies()
is invoked when a
new relevancy is created.relevancyGenusType
- the relevancy genus typeNullArgumentException
- relevancyGenusType is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForNewRelevanciesForSubject(Id subjectId) throws OperationFailedException, PermissionDeniedException
RelevancyReceiver.newRelevancies()
is invoked when a
new relevancy is created.subjectId
- the Id
of the Subject
to monitorNullArgumentException
- subjectId is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForNewRelevanciesForId(Id id) throws OperationFailedException, PermissionDeniedException
Id.
RelevancyReceiver.newRelevancies()
is invoked when a new relevancy is created.id
- the Id
to monitorNullArgumentException
- id is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedRelevancies() throws OperationFailedException, PermissionDeniedException
RelevancyReceiver.changedRelevancies()
is invoked when a
relevancy is changed.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedRelevanciesByGenusType(Type relevancyGenusType) throws OperationFailedException, PermissionDeniedException
RelevancyReceiver.changedRelevancies()
is invoked
when a relevancy is changed.relevancyGenusType
- the relevancy genus typeNullArgumentException
- relevancyGenusType is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedRelevanciesForSubject(Id subjectId) throws OperationFailedException, PermissionDeniedException
RelevancyReceiver.changedRelevancies()
is
invoked when a relevancy is changed.subjectId
- the Id
of the Subject
to monitorNullArgumentException
- subjectId is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedRelevanciesForId(Id id) throws OperationFailedException, PermissionDeniedException
Id.
RelevancyReceiver.changedRelevancies()
is
invoked when a relevancy is changed.id
- the Id
to monitorNullArgumentException
- id is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedRelevancy(Id relevancyId) throws OperationFailedException, PermissionDeniedException
RelevancyReceiver.changedRelevancies()
is invoked when the
specified relevancy is changed.relevancyId
- the Id
of the Relevancy
to monitorNullArgumentException
- relevancyId is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedRelevancies() throws OperationFailedException, PermissionDeniedException
RelevancyReceiver.deletedRelevancies()
is invoked when a
relevancy is deleted.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedRelevanciesByGenusType(Type relevancyGenusType) throws OperationFailedException, PermissionDeniedException
RelevancyReceiver.deletedRelevancies()
is invoked
when a relevancy is deleted.relevancyGenusType
- the relevancy genus typeNullArgumentException
- relevancyGenusType is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedRelevanciesForSubject(Id subjectId) throws OperationFailedException, PermissionDeniedException
RelevancyReceiver.deletedRelevancies()
is
invoked when a relevancy is deleted.subjectId
- the Id
of the Subject
to monitorNullArgumentException
- subjectId is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedRelevanciesForId(Id id) throws OperationFailedException, PermissionDeniedException
Id.
RelevancyReceiver.deletedRelevancies()
is
invoked when a relevancy is deleted.id
- the Id
to monitorNullArgumentException
- id is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedRelevancy(Id relevancyId) throws OperationFailedException, PermissionDeniedException
RelevancyReceiver.changedRelevancies()
is invoked when the
specified relevancy is deleted.relevancyId
- the Id
of the Relevancy
to monitorNullArgumentException
- relevancyId is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.