OSID Specifications
metering package
Version 3.1.0
metering package
Version 3.1.0
| Interface | osid.metering.UtilityReceiver | ||
|---|---|---|---|
| Implements | osid.OsidReceiver | ||
| Description |
The utility receiver is the consumer supplied interface
for receiving notifications pertaining to new, updated or
deleted | ||
| Method | newUtilities | ||
| Description |
The callback for notifications of new utilities. | ||
| Parameters | osid.id.IdList | utilityIds | the Ids of the new Utilities |
| Compliance | mandatory | This method must be implemented. | |
| Method | newAncestorUtility | ||
| Description |
The callback for notifications of new ancestors of a utility. | ||
| Parameters | osid.id.Id | utilityId | the Id of the registered Utility |
osid.id.Id | ancestorId | the Id of the new ancestor utility | |
| Compliance | mandatory | This method must be implemented. | |
| Method | newDescendantUtility | ||
| Description |
The callback for notifications of new descendant of a utility. | ||
| Parameters | osid.id.Id | utilityId | the Id of the registered Utility |
osid.id.Id | descendantId | the Id of the new descendant utility | |
| Compliance | mandatory | This method must be implemented. | |
| Method | changedUtilities | ||
| Description |
The callback for notification of updated utilities. | ||
| Parameters | osid.id.IdList | utilityIds | the Ids of the updated Utilities |
| Compliance | mandatory | This method must be implemented. | |
| Method | deletedUtilities | ||
| Description |
the callback for notification of deleted utilities. | ||
| Parameters | osid.id.IdList | utilityIds | the Ids of the registered Utilities |
| Compliance | mandatory | This method must be implemented. | |
| Method | deletedAncestorUtility | ||
| Description |
The callback for notifications of deleted ancestors of a utility, | ||
| Parameters | osid.id.Id | utilityId | the Id of the registered Utility |
osid.id.Id | ancestorId | the Id of the removed ancestor utility | |
| Compliance | mandatory | This method must be implemented. | |
| Method | deletedDescendantUtility | ||
| Description |
The callback for notifications of deleted descendants of a utility. | ||
| Parameters | osid.id.Id | utilityId | the Id of the registered Utility |
osid.id.Id | descendantId | the Id of the deleted descendant utility | |
| Compliance | mandatory | This method must be implemented. | |
| Method | restructuredUtilityHierarchy | ||
| Description |
The callback for notifications of changes to a utility hierarchy where the hierarchy needs to refreshed. | ||
| Compliance | mandatory | This method must be implemented. | |