org.osid.personnel

Interface RealmReceiver

All Superinterfaces:

OsidReceiver

public interface RealmReceiver
extends OsidReceiver

The realm receiver is the consumer supplied interface for receiving notifications pertaining to new, updated or deleted Realm objects.

Method Summary

Methods

Modifier and Type	Method and Description
void	changedRealms(IdList realmIds) The callback for notification of updated realms.
void	deletedAncestorRealm(Id realmId, Id ancestorId) The callback for notifications of deleted ancestors of a realm.
void	deletedDescendantRealm(Id realmId, Id descendantId) The callback for notifications of deleted descendants of a realm.
void	deletedRealms(IdList realmIds) the callback for notification of deleted realms.
void	newAncestorRealm(Id realmId, Id ancestorId) The callback for notifications of new ancestors of a realm.
void	newDescendantRealm(Id realmId, Id descendantId) The callback for notifications of new descendant of a realm.
void	newRealms(IdList realmIds) The callback for notifications of new realms.
void	restructuredRealmHierarchy() The callback for notifications of changes to a realm hierarchy where the hierarchy needs to refreshed.

Methods inherited from interface org.osid.OsidReceiver

down, up

Method Detail

newRealms

void newRealms(IdList realmIds)

The callback for notifications of new realms.

Parameters:

realmIds - the Ids of the new Realms

Compliance:

mandatory - This method must be implemented.

newAncestorRealm

void newAncestorRealm(Id realmId,
                    Id ancestorId)

The callback for notifications of new ancestors of a realm.

Parameters:

realmId - the Id of the registered Realm

ancestorId - the Id of the new ancestor realm

Compliance:

mandatory - This method must be implemented.

newDescendantRealm

void newDescendantRealm(Id realmId,
                      Id descendantId)

The callback for notifications of new descendant of a realm.

Parameters:

realmId - the Id of the registered Realm

descendantId - the Id of the new descendant realm

Compliance:

mandatory - This method must be implemented.

changedRealms

void changedRealms(IdList realmIds)

The callback for notification of updated realms.

Parameters:

realmIds - the Ids of the updated Realms

Compliance:

mandatory - This method must be implemented.

deletedRealms

void deletedRealms(IdList realmIds)

the callback for notification of deleted realms.

Parameters:

realmIds - the Ids of the registered Realms

Compliance:

mandatory - This method must be implemented.

deletedAncestorRealm

void deletedAncestorRealm(Id realmId,
                        Id ancestorId)

The callback for notifications of deleted ancestors of a realm.

Parameters:

realmId - the Id of the registered Realm

ancestorId - the Id of the removed ancestor realm

Compliance:

mandatory - This method must be implemented.

deletedDescendantRealm

void deletedDescendantRealm(Id realmId,
                          Id descendantId)

The callback for notifications of deleted descendants of a realm.

Parameters:

realmId - the Id of the registered Realm

descendantId - the Id of the deleted descendant realm

Compliance:

mandatory - This method must be implemented.

restructuredRealmHierarchy

void restructuredRealmHierarchy()

The callback for notifications of changes to a realm hierarchy where the hierarchy needs to refreshed.

Compliance:

mandatory - This method must be implemented.