OSID Logo
OSID Specifications
hold package
Version 3.0.0
Release Candidate Preview
Interfaceosid.hold.OublietteNotificationSession
Implementsosid.OsidSession
Description

This session defines methods to receive notifications on adds/changes to Oubliette 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 is closed.

MethodcanRegisterForOublietteNotifications
Description

Tests if this user can register for Oubliette 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.

Returnboolean false if notification methods are not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodreliableOublietteNotifications
Description

Reliable notifications are desired. In reliable mode, notifications are to be acknowledged using acknowledgeOublietteNotification() .

CompliancemandatoryThis method is must be implemented.
MethodunreliableOublietteNotifications
Description

Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged.

CompliancemandatoryThis method is must be implemented.
MethodacknowledgeOublietteNotification
Description

Acknowledge a oubliette notification.

Parametersosid.id.IdnotificationIdthe Id of the notification
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForNewOubliettes
Description

Register for notifications of new oubliettes. OublietteReceiver.newOubliettes() is invoked when a new Oubliette is created.

ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedOubliettes
Description

Registers for notification of updated oubliettes. OublietteReceiver.changedOubliettes() is invoked when an oubliette is changed.

ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedOubliette
Description

Registers for notification of an updated oubliette. OublietteReceiver.changedOubliettes() is invoked when the specified oubliette is changed.

Parametersosid.id.IdoublietteIdthe Id of the Oubliette to monitor
ErrorsNOT_FOUNDan oubliette was not found identified by the given Id
NULL_ARGUMENT oublietteId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedOubliettes
Description

Registers for notification of deletedoOubliettes. OublietteReceiver.deletedOubliettes() is invoked when an oubliette is deleted.

ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedOubliette
Description

Registers for notification of a deleted oubliette. OublietteReceiver.deletedOubliettes() is invoked when the specified oubliette is deleted.

Parametersosid.id.IdoublietteIdthe Id of the Oubliette to monitor
ErrorsNOT_FOUNDan oubliette was not found identified by the given Id
NULL_ARGUMENT oublietteId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedOublietteHierarchy
Description

Registers for notification of an updated oubliette hierarchy structure. OublietteReceiver.changedChildOfOubliettes() is invoked when a node experiences a change in its children.

ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedOublietteHierarchyForAncestors
Description

Oubliette Receiver.changedChildOfOubliettes() is invoked when the specified node or any of its ancestors experiences a change in its children.

Parametersosid.id.IdoublietteIdthe Id of the Oubliette node to monitor
ErrorsNULL_ARGUMENT oublietteId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedOublietteHierarchyForDescendants
Description

Registers for notification of an updated oubliette hierarchy structure. OublietteReceiver.changedChildOfOubliettes() is invoked when the specified node or any of its descendants experiences a change in its children.

Parametersosid.id.IdoublietteIdthe Id of the Oubliette node to monitor
ErrorsNULL_ARGUMENT oublietteId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.