org.osid.metering

Interface UtilityReceiver

All Superinterfaces:

OsidReceiver

public interface UtilityReceiver
extends OsidReceiver

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

Method Summary

Methods

Modifier and Type	Method and Description
void	changedUtilities(IdList utilityIds) The callback for notification of updated utilities.
void	deletedAncestorUtility(Id utilityId, Id ancestorId) The callback for notifications of deleted ancestors of a utility,
void	deletedDescendantUtility(Id utilityId, Id descendantId) The callback for notifications of deleted descendants of a utility.
void	deletedUtilities(IdList utilityIds) the callback for notification of deleted utilities.
void	newAncestorUtility(Id utilityId, Id ancestorId) The callback for notifications of new ancestors of a utility.
void	newDescendantUtility(Id utilityId, Id descendantId) The callback for notifications of new descendant of a utility.
void	newUtilities(IdList utilityIds) The callback for notifications of new utilities.
void	restructuredUtilityHierarchy() The callback for notifications of changes to a utility hierarchy where the hierarchy needs to refreshed.

Methods inherited from interface org.osid.OsidReceiver

down, up

Method Detail

newUtilities

void newUtilities(IdList utilityIds)

The callback for notifications of new utilities.

Parameters:

utilityIds - the Ids of the new Utilities

Compliance:

mandatory - This method must be implemented.

newAncestorUtility

void newAncestorUtility(Id utilityId,
                      Id ancestorId)

The callback for notifications of new ancestors of a utility.

Parameters:

utilityId - the Id of the registered Utility

ancestorId - the Id of the new ancestor utility

Compliance:

mandatory - This method must be implemented.

newDescendantUtility

void newDescendantUtility(Id utilityId,
                        Id descendantId)

The callback for notifications of new descendant of a utility.

Parameters:

utilityId - the Id of the registered Utility

descendantId - the Id of the new descendant utility

Compliance:

mandatory - This method must be implemented.

changedUtilities

void changedUtilities(IdList utilityIds)

The callback for notification of updated utilities.

Parameters:

utilityIds - the Ids of the updated Utilities

Compliance:

mandatory - This method must be implemented.

deletedUtilities

void deletedUtilities(IdList utilityIds)

the callback for notification of deleted utilities.

Parameters:

utilityIds - the Ids of the registered Utilities

Compliance:

mandatory - This method must be implemented.

deletedAncestorUtility

void deletedAncestorUtility(Id utilityId,
                          Id ancestorId)

The callback for notifications of deleted ancestors of a utility,

Parameters:

utilityId - the Id of the registered Utility

ancestorId - the Id of the removed ancestor utility

Compliance:

mandatory - This method must be implemented.

deletedDescendantUtility

void deletedDescendantUtility(Id utilityId,
                            Id descendantId)

The callback for notifications of deleted descendants of a utility.

Parameters:

utilityId - the Id of the registered Utility

descendantId - the Id of the deleted descendant utility

Compliance:

mandatory - This method must be implemented.

restructuredUtilityHierarchy

void restructuredUtilityHierarchy()

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

Compliance:

mandatory - This method must be implemented.