OSID Specifications
personnel package
Version 3.0.0
Release Candidate Preview
personnel package
Version 3.0.0
Release Candidate Preview
| Interface | osid.personnel.RealmReceiver | ||
|---|---|---|---|
| Implements | osid.OsidReceiver | ||
| Description |
The realm receiver is the consumer supplied interface for
receiving notifications pertaining to new, updated or deleted
| ||
| Method | newRealms | ||
| Description |
The callback for notifications of new realms. | ||
| Parameters | osid.id.IdList | realmIds | the Ids of the new Realms |
| Compliance | mandatory | This method must be implemented. | |
| Method | newAncestorRealm | ||
| Description |
The callback for notifications of new ancestors of a realm. | ||
| Parameters | osid.id.Id | realmId | the Id of the registered Realm |
osid.id.Id | ancestorId | the Id of the new ancestor realm | |
| Compliance | mandatory | This method must be implemented. | |
| Method | newDescendantRealm | ||
| Description |
The callback for notifications of new descendant of a realm. | ||
| Parameters | osid.id.Id | realmId | the Id of the registered Realm |
osid.id.Id | descendantId | the Id of the new descendant realm | |
| Compliance | mandatory | This method must be implemented. | |
| Method | changedRealms | ||
| Description |
The callback for notification of updated realms. | ||
| Parameters | osid.id.IdList | realmIds | the Ids of the updated Realms |
| Compliance | mandatory | This method must be implemented. | |
| Method | deletedRealms | ||
| Description |
the callback for notification of deleted realms. | ||
| Parameters | osid.id.IdList | realmIds | the Ids of the registered Realms |
| Compliance | mandatory | This method must be implemented. | |
| Method | deletedAncestorRealm | ||
| Description |
The callback for notifications of deleted ancestors of a realm. | ||
| Parameters | osid.id.Id | realmId | the Id of the registered Realm |
osid.id.Id | ancestorId | the Id of the removed ancestor realm | |
| Compliance | mandatory | This method must be implemented. | |
| Method | deletedDescendantRealm | ||
| Description |
The callback for notifications of deleted descendants of a realm. | ||
| Parameters | osid.id.Id | realmId | the Id of the registered Realm |
osid.id.Id | descendantId | the Id of the deleted descendant realm | |
| Compliance | mandatory | This method must be implemented. | |
| Method | restructuredRealmHierarchy | ||
| Description |
The callback for notifications of changes to a realm hierarchy where the hierarchy needs to refreshed. | ||
| Compliance | mandatory | This method must be implemented. | |