org.osid.voting.rules

Interface RaceProcessorRuleLookupSession

All Superinterfaces:

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

public interface RaceProcessorRuleLookupSession
extends OsidSession

This session provides methods to retrieve RaceProcessor to Race mappings.

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 processor defined explicitly in the current polls
• federated polls view: All methods in this session operate, retrieve and pertain to all race processor defined in this polls and any other race processor implicitly available in this polls through polls inheritence.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canLookupRaceProcessorRules() Tests if this user can perform lookups of race processor/race mappings.
Polls	getPolls() Gets the Polls associated with this session.
Id	getPollsId() Gets the Polls Id associated with this session.
IdList	getRaceIdsForRaceProcessor(Id raceProcessorId) Gets the Race Ids mapped to a RaceProcessor.
IdList	getRaceProcessorIdsForRace(Id raceId) Gets the RaceProcessor Id associated with a Race.
RaceProcessorList	getRaceProcessorsForRace(Id raceId) Gets the RaceProcessor associated with a Race.
RaceList	getRacesForRaceProcessor(Id raceProcessorId) Gets the Races mapped to a RaceProcessor.
void	useComparativeRaceProcessorRuleView() 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	usePlenaryRaceProcessorRuleView() A complete view of the RaceProcessor 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.

canLookupRaceProcessorRules

boolean canLookupRaceProcessorRules()

Tests if this user can perform lookups of race processor/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.

useComparativeRaceProcessorRuleView

void useComparativeRaceProcessorRuleView()

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.

usePlenaryRaceProcessorRuleView

void usePlenaryRaceProcessorRuleView()

A complete view of the RaceProcessor 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 processor 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.

getRaceProcessorIdsForRace

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

Gets the RaceProcessor Id associated with a Race.

Parameters:

raceId - Id of the Race

Returns:

the race processor 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.

getRaceProcessorsForRace

RaceProcessorList getRaceProcessorsForRace(Id raceId)
                                           throws NotFoundException,
                                                  OperationFailedException,
                                                  PermissionDeniedException

Gets the RaceProcessor associated with a Race.

Parameters:

raceId - Id of the Auction

Returns:

the race processors

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.

getRaceIdsForRaceProcessor

IdList getRaceIdsForRaceProcessor(Id raceProcessorId)
                                  throws NotFoundException,
                                         OperationFailedException,
                                         PermissionDeniedException

Gets the Race Ids mapped to a RaceProcessor.

Parameters:

raceProcessorId - Id of a RaceProcessor

Returns:

list of race Ids

Throws:

NotFoundException - raceProcessorId is not found

NullArgumentException - raceProcessorId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getRacesForRaceProcessor

RaceList getRacesForRaceProcessor(Id raceProcessorId)
                                  throws NotFoundException,
                                         OperationFailedException,
                                         PermissionDeniedException

Gets the Races mapped to a RaceProcessor.

Parameters:

raceProcessorId - Id of a RaceProcessor

Returns:

list of races

Throws:

NotFoundException - raceProcessorId is not found

NullArgumentException - raceProcessorId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.