| Interface | osid.voting.rules.RaceConstrainerEnablerNotificationSession | ||
|---|---|---|---|
| Implements | osid.OsidSession | ||
| Description |
This session defines methods to receive notifications on
adds/changes to The two views defined in this session correspond to the
views in the | ||
| Method | getPollsId | ||
| Description |
Gets the | ||
| Return | osid.id.Id | the Polls Id associated with this session | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getPolls | ||
| Description |
Gets the | ||
| Return | osid.voting.Polls | the polls | |
| Errors | OPERATION_FAILED | unable to complete request | |
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | canRegisterForRaceConstrainerEnablerNotifications | ||
| 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 | useFederatedPollsView | ||
| Description |
Federates the view for methods in this session. A federated view will include enablers in polls which are children of this polls in the polls hierarchy. | ||
| Compliance | mandatory | This method is must be implemented. | |
| Method | useIsolatedPollsView | ||
| Description |
Isolates the view for methods in this session. An isolated view restricts notifications to this polls only. | ||
| Compliance | mandatory | This method is must be implemented. | |
| Method | reliableRaceConstrainerEnablerNotifications | ||
| Description |
Reliable notifications are desired. In reliable mode,
notifications are to be acknowledged using | ||
| Compliance | mandatory | This method is must be implemented. | |
| Method | unreliableRaceConstrainerEnablerNotifications | ||
| Description |
Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged. | ||
| Compliance | mandatory | This method is must be implemented. | |
| Method | acknowledgeRaceConstrainerEnablerNotification | ||
| Description |
Acknowledge a race constrainer enabler notification. | ||
| Parameters | osid.id.Id | notificationId | the Id of the notification |
| Errors | OPERATION_FAILED | unable to complete request | |
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | registerForNewRaceConstrainerEnablers | ||
| Description |
Register for notifications of new race constrainer
enablers. | ||
| Errors | OPERATION_FAILED | unable to complete request | |
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | registerForChangedRaceConstrainerEnablers | ||
| Description |
Registers for notification of updated polls enabelrs.
| ||
| Errors | OPERATION_FAILED | unable to complete request | |
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | registerForChangedRaceConstrainerEnabler | ||
| Description |
Registers for notification of an updated race
constrainer enabler. | ||
| Parameters | osid.id.Id | raceConstrainerEnablerId | the Id of the RaceConstrainerEnabler to
monitor |
| Errors | NULL_ARGUMENT | raceConstrainerEnablerId is null | |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | registerForDeletedRaceConstrainerEnablers | ||
| Description |
Registers for notification of deleted race constrainer
enablers. | ||
| Errors | OPERATION_FAILED | unable to complete request | |
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | registerForDeletedRaceConstrainerEnabler | ||
| Description |
Registers for notification of a deleted race
constrainer enabler. | ||
| Parameters | osid.id.Id | raceConstrainerEnablerId | the Id of the RaceConstrainerEnabler to
monitor |
| Errors | NULL_ARGUMENT | raceConstrainerEnablerId is null | |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |