Interface | osid.hold.OublietteNotificationSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session defines methods to receive notifications on
adds/changes to | ||
Method | canRegisterForOublietteNotifications | ||
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 | reliableOublietteNotifications | ||
Description |
Reliable notifications are desired. In reliable mode,
notifications are to be acknowledged using | ||
Compliance | mandatory | This method is must be implemented. | |
Method | unreliableOublietteNotifications | ||
Description |
Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | acknowledgeOublietteNotification | ||
Description |
Acknowledge a oubliette 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 | registerForNewOubliettes | ||
Description |
Register for notifications of new oubliettes. | ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedOubliettes | ||
Description |
Registers for notification of updated oubliettes.
| ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedOubliette | ||
Description |
Registers for notification of an updated oubliette.
| ||
Parameters | osid.id.Id | oublietteId | the Id of the Oubliette to monitor |
Errors | NOT_FOUND | an oubliette was not found identified by the given Id | |
NULL_ARGUMENT | oublietteId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForDeletedOubliettes | ||
Description |
Registers for notification of deletedoOubliettes.
| ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForDeletedOubliette | ||
Description |
Registers for notification of a deleted oubliette.
| ||
Parameters | osid.id.Id | oublietteId | the Id of the Oubliette to monitor |
Errors | NOT_FOUND | an oubliette was not found identified by the given Id | |
NULL_ARGUMENT | oublietteId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedOublietteHierarchy | ||
Description |
Registers for notification of an updated oubliette
hierarchy structure. | ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedOublietteHierarchyForAncestors | ||
Description |
Oubliette | ||
Parameters | osid.id.Id | oublietteId | the Id of the Oubliette node to monitor |
Errors | NULL_ARGUMENT | oublietteId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedOublietteHierarchyForDescendants | ||
Description |
Registers for notification of an updated oubliette
hierarchy structure. | ||
Parameters | osid.id.Id | oublietteId | the Id of the Oubliette node to monitor |
Errors | NULL_ARGUMENT | oublietteId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |