public interface OntologyNotificationSession extends OsidSession
This session defines methods to receive notifications on adds/changes
to Ontology
objects. 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 i
Modifier and Type | Method and Description |
---|---|
void |
acknowledgeOntologyNotification(Id notificationId)
Acknowledge an ontology notification.
|
boolean |
canRegisterForOntologyNotifications()
Tests if this user can register for
Ontology
notifications. |
void |
registerForChangedOntologies()
Registers for notification of updated ontologies.
|
void |
registerForChangedOntology(Id ontologyId)
Registers for notification of an updated ontology.
|
void |
registerForChangedOntologyHierarchy()
Registers for notification of an updated ontology hierarchy structure.
|
void |
registerForChangedOntologyHierarchyForAncestors(Id ontologyId)
OntologyReceiver.changedChildOfOntologiess() is invoked
when the specified node or any of its ancestors experiences a change
in its children. |
void |
registerForChangedOntologyHierarchyForDescendants(Id ontologyId)
Registers for notification of an updated ontology hierarchy structure.
|
void |
registerForDeletedOntologies()
Registers for notification of deleted ontologies.
|
void |
registerForDeletedOntology(Id ontologyId)
Registers for notification of a deleted ontology.
|
void |
registerForNewOntologies()
Register for notifications of new ontologies.
|
void |
reliableOntologyNotifications()
Reliable notifications are desired.
|
void |
unreliableOntologyNotifications()
Unreliable notifications are desired.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canRegisterForOntologyNotifications()
Ontology
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 reliableOntologyNotifications()
acknowledgeOntologyNotification()
.mandatory
- This method is must be implemented. void unreliableOntologyNotifications()
mandatory
- This method is must be implemented. void acknowledgeOntologyNotification(Id notificationId) throws OperationFailedException, PermissionDeniedException
notificationId
- the Id
of the notificationOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForNewOntologies() throws OperationFailedException, PermissionDeniedException
OntologyReceiver.newOntologies()
is invoked when a new
Ontology
is created.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedOntologies() throws OperationFailedException, PermissionDeniedException
OntologyReceiver.changedOntologies()
is invoked when an
ontology is changed.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedOntology(Id ontologyId) throws OperationFailedException, PermissionDeniedException
OntologyReceiver.changedOntologies()
is invoked when the
specified ontology is changed.ontologyId
- the Id
of the ontology to monitorNullArgumentException
- ontologyId is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedOntologies() throws OperationFailedException, PermissionDeniedException
OntologyReceiver.deletedOntologies()
is invoked when a
calenedar is deleted.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedOntology(Id ontologyId) throws OperationFailedException, PermissionDeniedException
OntologyReceiver.deletedOntologies()
is invoked when the
specified ontology is deleted.ontologyId
- the Id
of the ontology to monitorNullArgumentException
- ontologyId is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedOntologyHierarchy() throws OperationFailedException, PermissionDeniedException
OntologyReceiver.changedChildOfOntologies()
is invoked
when a node experiences a change in its children.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedOntologyHierarchyForAncestors(Id ontologyId) throws OperationFailedException, PermissionDeniedException
OntologyReceiver.changedChildOfOntologiess()
is invoked
when the specified node or any of its ancestors experiences a change
in its children.ontologyId
- the Id
of the Ontology
node to monitorNullArgumentException
- ontologyId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedOntologyHierarchyForDescendants(Id ontologyId) throws OperationFailedException, PermissionDeniedException
OntologyReceiver.changedChildOfOntologies()
is invoked
when the specified node or any of its descendants experiences a change
in its children.ontologyId
- the Id
of the Ontology
node to monitorNullArgumentException
- ontologyId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.