Interface | osid.personnel.RealmNotificationSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session defines methods to receive notifications on
adds/changes to Notifications are triggered with changes to the | ||
Method | canRegisterForRealmNotifications | ||
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 | registerForNewRealms | ||
Description |
Register for notifications of new realms. | ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForNewRealmAncestors | ||
Description |
Registers for notification of an updated hierarchy
structure that introduces a new ancestor of the specified
realm. | ||
Parameters | osid.id.Id | realmId | the Id of the Realm node to monitor |
Errors | NULL_ARGUMENT | realmId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForNewRealmDescendants | ||
Description |
Registers for notification of an updated hierarchy
structure that introduces a new descendant of the
specified realm. | ||
Parameters | osid.id.Id | realmId | the Id of the Realm node to monitor |
Errors | NULL_ARGUMENT | realmId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedRealms | ||
Description |
Registers for notification of updated realms. | ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedRealm | ||
Description |
Registers for notification of an updated realm. | ||
Parameters | osid.id.Id | realmId | the Id of the Realm to monitor |
Errors | NULL_ARGUMENT | realmId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForDeletedRealms | ||
Description |
Registers for notification of deleted realms. | ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForDeletedRealm | ||
Description |
Registers for notification of a deleted realm. | ||
Parameters | osid.id.Id | realmId | the Id of the Realm to monitor |
Errors | NULL_ARGUMENT | realmId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForDeletedRealmAncestors | ||
Description |
Registers for notification of an updated hierarchy
structure that removes an ancestor of the specified realm.
| ||
Parameters | osid.id.Id | realmId | the Id of the Realm to monitor |
Errors | NULL_ARGUMENT | realmId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForDeletedRealmDescendants | ||
Description |
Registers for notification of an updated hierarchy
structure that removes a descendant of the specified
realm. | ||
Parameters | osid.id.Id | realmId | the Id of the Realm to monitor |
Errors | NULL_ARGUMENT | realmId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |