OSID Logo
OSID Specifications
personnel package
Version 3.0.0
Release Candidate Preview
Interfaceosid.personnel.RealmNotificationSession
Implementsosid.OsidSession
Description

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

Notifications are triggered with changes to the Realm object itself. Adding and removing persons result in notifications available from the notification session for persons.

MethodcanRegisterForRealmNotifications
Description

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

Register for notifications of new realms. RealmReceiver.newRealm() is invoked when a new Realm is created.

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

Registers for notification of an updated hierarchy structure that introduces a new ancestor of the specified realm. RealmReceiver.newAncestorRealms() is invoked when the specified realm node gets a new ancestor.

Parametersosid.id.IdrealmIdthe Id of the Realm node to monitor
ErrorsNULL_ARGUMENT realmId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForNewRealmDescendants
Description

Registers for notification of an updated hierarchy structure that introduces a new descendant of the specified realm. RealmReceiver.newDescendantRealm() is invoked when the specified realm node gets a new descendant.

Parametersosid.id.IdrealmIdthe Id of the Realm node to monitor
ErrorsNULL_ARGUMENT realmId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedRealms
Description

Registers for notification of updated realms. RealmReceiver.changedRealms() is invoked when a realm is changed.

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

Registers for notification of an updated realm. RealmReceiver.changedRealms() is invoked when the specified realm is changed.

Parametersosid.id.IdrealmIdthe Id of the Realm to monitor
ErrorsNULL_ARGUMENT realmId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedRealms
Description

Registers for notification of deleted realms. RealmReceiver.deletedRealms() is invoked when a realm is deleted.

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

Registers for notification of a deleted realm. RealmReceiver.deletedRealms() is invoked when the specified realm is deleted.

Parametersosid.id.IdrealmIdthe Id of the Realm to monitor
ErrorsNULL_ARGUMENT realmId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedRealmAncestors
Description

Registers for notification of an updated hierarchy structure that removes an ancestor of the specified realm. RealmReceiver.deletedAncestorRealm() is invoked when the specified realm node loses an ancestor.

Parametersosid.id.IdrealmIdthe Id of the Realm to monitor
ErrorsNULL_ARGUMENT realmId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedRealmDescendants
Description

Registers for notification of an updated hierarchy structure that removes a descendant of the specified realm. RealmReceiver.deletedDescendantRealm() is invoked when the specified realm node loses a descendant.

Parametersosid.id.IdrealmIdthe Id of the Realm to monitor
ErrorsNULL_ARGUMENT realmId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.