org.osid.voting.rules

Interface RaceConstrainerRuleLookupSession

All Superinterfaces:

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

public interface RaceConstrainerRuleLookupSession
extends OsidSession

This session provides methods to retrieve RaceConstrainer to Race mappings. A Race with multiple RaceConstrainers means any positive rule evaluation across the constrainers result in an accessible Race.

This lookup session defines several views:

• comparative view: elements may be silently omitted or re-ordered
• plenary view: provides a complete result set or is an error condition
• isolated polls view: All methods in this session operate, retrieve and pertain race constrainer defined explicitly in the current polls
• federated polls view: All methods in this session operate, retrieve and pertain to all race constrainer defined in this polls and any other race constrainer implicitly available in this polls through polls inheritence.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canLookupRaceConstrainerRules() Tests if this user can perform lookups of race constrainer/race mappings.
Polls	getPolls() Gets the Polls associated with this session.
Id	getPollsId() Gets the Polls Id associated with this session.
IdList	getRaceConstrainerIdsForRace(Id raceId) Gets the RaceConstrainer Id associated with a Race.
RaceConstrainerList	getRaceConstrainersForRace(Id raceId) Gets the RaceConstrainer associated with a Race.
IdList	getRaceIdsForRaceConstrainer(Id raceConstrainerId) Gets the Race Ids mapped to a RaceConstrainer.
RaceList	getRacesForRaceConstrainer(Id raceConstrainerId) Gets the Races mapped to a RaceConstrainer.
void	useComparativeRaceConstrainerRuleView() The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error.
void	useFederatedPollsView() Federates the view for methods in this session.
void	useIsolatedPollsView() Isolates the view for methods in this session.
void	usePlenaryRaceConstrainerRuleView() A complete view of the RaceConstrainer and Race returns is desired.

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.

canLookupRaceConstrainerRules

boolean canLookupRaceConstrainerRules()

Tests if this user can perform lookups of race constrainer/race mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known lookup 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 lookup operations to unauthorized users.

Returns:

false if looking up mappings is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

useComparativeRaceConstrainerRuleView

void useComparativeRaceConstrainerRuleView()

The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision.

Compliance:

mandatory - This method is must be implemented.

usePlenaryRaceConstrainerRuleView

void usePlenaryRaceConstrainerRuleView()

A complete view of the RaceConstrainer and Race returns is desired. Methods will return what is requested or result in an error. This view is used when greater precision is desired at the expense of interoperability.

Compliance:

mandatory - This method is must be implemented.

useFederatedPollsView

void useFederatedPollsView()

Federates the view for methods in this session. A federated view will include race constrainer 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 lookups to this polls only.

Compliance:

mandatory - This method is must be implemented.

getRaceConstrainerIdsForRace

IdList getRaceConstrainerIdsForRace(Id raceId)
                                    throws NotFoundException,
                                           OperationFailedException,
                                           PermissionDeniedException

Gets the RaceConstrainer Id associated with a Race.

Parameters:

raceId - Id of the Race

Returns:

the race constrainer Ids

Throws:

NotFoundException - raceId is not found

NullArgumentException - raceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getRaceConstrainersForRace

RaceConstrainerList getRaceConstrainersForRace(Id raceId)
                                               throws NotFoundException,
                                                      OperationFailedException,
                                                      PermissionDeniedException

Gets the RaceConstrainer associated with a Race.

Parameters:

raceId - Id of the Race

Returns:

the race constrainers

Throws:

NotFoundException - raceId is not found

NullArgumentException - raceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getRaceIdsForRaceConstrainer

IdList getRaceIdsForRaceConstrainer(Id raceConstrainerId)
                                    throws NotFoundException,
                                           OperationFailedException,
                                           PermissionDeniedException

Gets the Race Ids mapped to a RaceConstrainer.

Parameters:

raceConstrainerId - Id of a RaceConstrainer

Returns:

list of race Ids

Throws:

NotFoundException - raceConstrainerId is not found

NullArgumentException - raceConstrainerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getRacesForRaceConstrainer

RaceList getRacesForRaceConstrainer(Id raceConstrainerId)
                                    throws NotFoundException,
                                           OperationFailedException,
                                           PermissionDeniedException

Gets the Races mapped to a RaceConstrainer.

Parameters:

raceConstrainerId - Id of a RaceConstrainer

Returns:

list of races

Throws:

NotFoundException - raceConstrainerId is not found

NullArgumentException - raceConstrainerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.