Interface | osid.ontology.OntologyNotificationSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session defines methods to receive notifications on
adds/changes to | ||
Method | canRegisterForOntologyNotifications | ||
Description |
Tests if this user can register for | ||
Return | boolean | false if notification methods are not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | reliableOntologyNotifications | ||
Description |
Reliable notifications are desired. In reliable mode,
notifications are to be acknowledged using | ||
Compliance | mandatory | This method is must be implemented. | |
Method | unreliableOntologyNotifications | ||
Description |
Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | acknowledgeOntologyNotification | ||
Description |
Acknowledge an ontology notification. | ||
Parameters | osid.id.Id | notificationId | the Id of the notification |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForNewOntologies | ||
Description |
Register for notifications of new ontologies. | ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedOntologies | ||
Description |
Registers for notification of updated ontologies.
| ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedOntology | ||
Description |
Registers for notification of an updated ontology.
| ||
Parameters | osid.id.Id | ontologyId | the Id of the ontology to monitor |
Errors | NULL_ARGUMENT | ontologyId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForDeletedOntologies | ||
Description |
Registers for notification of deleted ontologies.
| ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForDeletedOntology | ||
Description |
Registers for notification of a deleted ontology.
| ||
Parameters | osid.id.Id | ontologyId | the Id of the ontology to monitor |
Errors | NULL_ARGUMENT | ontologyId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedOntologyHierarchy | ||
Description |
Registers for notification of an updated ontology
hierarchy structure. | ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedOntologyHierarchyForAncestors | ||
Description |
| ||
Parameters | osid.id.Id | ontologyId | the Id of the Ontology node to monitor |
Errors | NULL_ARGUMENT | ontologyId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedOntologyHierarchyForDescendants | ||
Description |
Registers for notification of an updated ontology
hierarchy structure. | ||
Parameters | osid.id.Id | ontologyId | the Id of the Ontology node to monitor |
Errors | NULL_ARGUMENT | ontologyId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |