Interface | osid.metering.MeterNotificationSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session defines methods to receive notifications on new or deleted meters. This session is intended for consumers needing to synchronize their state with this service without the use of polling. Notifications are cancelled when this session is closed. This session registers notifications for the Meter itself. | ||
Method | getUtilityId | ||
Description |
Gets the | ||
Return | osid.id.Id | the Utility Id associated with this session | |
Compliance | mandatory | This method must be implemented. | |
Method | getUtility | ||
Description |
Gets the | ||
Return | osid.metering.Utility | the Utility associated with this session | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canRegisterForMeterNotifications | ||
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 | useFederatedUtilityView | ||
Description |
Federates the view for methods in this session. A federated view will include meters from parent utilities in the utility hierarchy. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useIsolatedUtilityView | ||
Description |
Isolates the view for methods in this session. An isolated view restricts notifications for meters to this utility only. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | registerForNewMeters | ||
Description |
Register for notifications of new meters. | ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedMeters | ||
Description |
Register for notifications of new meters. | ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedMeter | ||
Description |
Registers for notification of an updated meter. | ||
Parameters | osid.id.Id | meterId | the Id of the Meter to monitor |
Errors | NULL_ARGUMENT | meterId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForDeletedMeters | ||
Description |
Registers for notification of deleted meters. | ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForDeletedMeter | ||
Description |
Registers for notification of a deleted meter. | ||
Parameters | osid.id.Id | meterId | the Id of the Meter to monitor |
Errors | NULL_ARGUMENT | meterId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |