org.osid.voting.rules

Interface RaceConstrainerEnablerNotificationSession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidSession

public interface RaceConstrainerEnablerNotificationSession
extends OsidSession

This session defines methods to receive notifications on adds/changes to RaceConstrainerEnabler objects in this Polls. This also includes existing RaceConstrainerEnablers that may appear or disappear due to changes in the Polls hierarchy, 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.

The two views defined in this session correspond to the views in the RaceConstrainerEnablerLookupSession.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canRegisterForRaceConstrainerEnablerNotifications() Tests if this user can register for RaceConstrainerEnabler notifications.
Polls	getPolls() Gets the Polls associated with this session.
Id	getPollsId() Gets the Polls Id associated with this session.
void	registerForChangedRaceConstrainerEnabler(Id raceConstrainerEnablerId) Registers for notification of an updated race constrainer enabler.
void	registerForChangedRaceConstrainerEnablers() Registers for notification of updated polls enabelrs.
void	registerForDeletedRaceConstrainerEnabler(Id raceConstrainerEnablerId) Registers for notification of a deleted race constrainer enabler.
void	registerForDeletedRaceConstrainerEnablers() Registers for notification of deleted race constrainer enablers.
void	registerForNewRaceConstrainerEnablers() Register for notifications of new race constrainer enablers.
void	useFederatedPollsView() Federates the view for methods in this session.
void	useIsolatedPollsView() Isolates the view for methods in this session.

Methods inherited from interface org.osid.OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Methods inherited from interface org.osid.binding.java.OsidSession

close

Methods inherited from interface java.io.Closeable

close

Method Detail

getPollsId

Id getPollsId()

Gets the Polls Id associated with this session.

Returns:

the Polls Id associated with this session

Compliance:

mandatory - This method must be implemented.

getPolls

Polls getPolls()
               throws OperationFailedException,
                      PermissionDeniedException

Gets the Polls associated with this session.

Returns:

the polls

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canRegisterForRaceConstrainerEnablerNotifications

boolean canRegisterForRaceConstrainerEnablerNotifications()

Tests if this user can register for RaceConstrainerEnabler notifications. A return of true does not guarantee successful authorization. A return of false indicates that it is known all methods in this session will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer notification operations.

Returns:

false if notification methods are not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

useFederatedPollsView

void useFederatedPollsView()

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.

useIsolatedPollsView

void useIsolatedPollsView()

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.

registerForNewRaceConstrainerEnablers

void registerForNewRaceConstrainerEnablers()
                                           throws OperationFailedException,
                                                  PermissionDeniedException

Register for notifications of new race constrainer enablers. RaceConstrainerEnablerReceiver.newRaceConstrainerEnabler() is invoked when a new RaceConstrainerEnabler appears in this polls.

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForChangedRaceConstrainerEnablers

void registerForChangedRaceConstrainerEnablers()
                                               throws OperationFailedException,
                                                      PermissionDeniedException

Registers for notification of updated polls enabelrs. RaceConstrainerEnablerReceiver.changedRaceConstrainerEnabler() is invoked when a race constrainer enabler in this polls is changed.

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForChangedRaceConstrainerEnabler

void registerForChangedRaceConstrainerEnabler(Id raceConstrainerEnablerId)
                                              throws OperationFailedException,
                                                     PermissionDeniedException

Registers for notification of an updated race constrainer enabler. ProvisionableReceiver.changedRaceConstrainerEnabler() is invoked when the specified race constrainer enabler in this polls is changed.

Parameters:

raceConstrainerEnablerId - the Id of the RaceConstrainerEnabler to monitor

Throws:

NullArgumentException - raceConstrainerEnablerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForDeletedRaceConstrainerEnablers

void registerForDeletedRaceConstrainerEnablers()
                                               throws OperationFailedException,
                                                      PermissionDeniedException

Registers for notification of deleted race constrainer enablers. RaceConstrainerEnablerReceiver.deletedRaceConstrainerEnabler() is invoked when a race constrainer enabler is deleted or removed from this polls.

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForDeletedRaceConstrainerEnabler

void registerForDeletedRaceConstrainerEnabler(Id raceConstrainerEnablerId)
                                              throws OperationFailedException,
                                                     PermissionDeniedException

Registers for notification of a deleted race constrainer enabler. RaceConstrainerEnablerReceiver.deletedRaceConstrainerEnabler() is invoked when the specified race constrainer enabler is deleted or removed from this polls.

Parameters:

raceConstrainerEnablerId - the Id of the RaceConstrainerEnabler to monitor

Throws:

NullArgumentException - raceConstrainerEnablerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.