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 |
---|---|
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 |
registerForDeletedOntologies()
Registers for notification of deleted ontologies.
|
void |
registerForDeletedOntology(Id ontologyId)
Registers for notification of a deleted ontology.
|
void |
registerForDeletedOntologyAncestors(Id ontologyId)
Registers for notification if an ancestor is removed from the
specified ontology in the ontology hierarchy.
|
void |
registerForDeletedOntologyDescendants(Id ontologyId)
Registers for notification if a descendant is removed from fthe
specified ontology in the calndar hierarchy.
|
void |
registerForNewOntologies()
Register for notifications of new ontologies.
|
void |
registerForNewOntologyAncestors(Id ontologyId)
Registers for notification if an ancestor is added to the specified
ontology in the ontology hierarchy.
|
void |
registerForNewOntologyDescendants(Id ontologyId)
Registers for notification if a descendant is added to the specified
ontology in the ontology hierarchy.
|
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 registerForNewOntologies() throws OperationFailedException, PermissionDeniedException
OntologyReceiver.newOntology()
is invoked when a new
Ontology
is created.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForNewOntologyAncestors(Id ontologyId) throws OperationFailedException, PermissionDeniedException
OntologyReceiver.newOntologyAncestor()
is invoked when the
specified ontology experiences an addition in ancestry.ontologyId
- the Id
of the ontology to monitorNullArgumentException
- ontologyId is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForNewOntologyDescendants(Id ontologyId) throws OperationFailedException, PermissionDeniedException
OntologyReceiver.newOntologyDescendant()
is invoked when the
specified ontology experiences an addition in descendants.ontologyId
- the Id
of the ontology to monitorNullArgumentException
- ontologyId is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedOntologies() throws OperationFailedException, PermissionDeniedException
OntologyReceiver.changedOntology()
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.changedOntology()
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.deletedOntology()
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.deletedOntology()
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 registerForDeletedOntologyAncestors(Id ontologyId) throws OperationFailedException, PermissionDeniedException
OntologyReceiver.deletedOntologyAncestor()
is invoked when the
specified ontology experiences a removal of an ancestor.ontologyId
- the Id
of the ontology to monitorNullArgumentException
- ontologyId is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedOntologyDescendants(Id ontologyId) throws OperationFailedException, PermissionDeniedException
OntologyReceiver.deletedOntologyDescednant()
is invoked when
the specified ontology experiences a removal of one of its
descendants.ontologyId
- the Id
of the ontology to monitorNullArgumentException
- ontologyId is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.