org.osid.voting.rules

Interface RaceProcessorPollsSession

All Superinterfaces:

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

public interface RaceProcessorPollsSession
extends OsidSession

This session provides methods to retrieve RaceProcessor to Polls mappings. a RaceProcessor may appear in multiple Polls objects. Each polls may have its own authorizations governing who is allowed to look at it.

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

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canLookupRaceProcessorPollsMappings() Tests if this user can perform lookups of race processor/polls mappings.
PollsList	getPollsByRaceProcessor(Id raceProcessorId) Gets the Polls mapped to a RaceProcessor.
IdList	getPollsIdsByRaceProcessor(Id raceProcessorId) Gets the Polls Ids mapped to a RaceProcessor.
IdList	getRaceProcessorIdsByPolls(Id pollsId) Gets the list of RaceProcessorIds associated with a Polls.
IdList	getRaceProcessorIdsByPolls(IdList pollsIds) Gets the list of RaceProcessor Ids corresponding to a list of Polls.
RaceProcessorList	getRaceProcessorsByPolls(Id pollsId) Gets the list of race processors associated with a Polls.
RaceProcessorList	getRaceProcessorsByPolls(IdList pollsIds) Gets the list of race processor corresponding to a list of Polls.
void	useComparativeRaceProcessorPollsView() 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	usePlenaryRaceProcessorPollsView() A complete view of the RaceProcessor and Polls 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

canLookupRaceProcessorPollsMappings

boolean canLookupRaceProcessorPollsMappings()

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

useComparativeRaceProcessorPollsView

void useComparativeRaceProcessorPollsView()

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.

usePlenaryRaceProcessorPollsView

void usePlenaryRaceProcessorPollsView()

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

getRaceProcessorIdsByPolls

IdList getRaceProcessorIdsByPolls(Id pollsId)
                                  throws NotFoundException,
                                         OperationFailedException,
                                         PermissionDeniedException

Gets the list of RaceProcessorIds associated with a Polls.

Parameters:

pollsId - Id of the Polls

Returns:

list of related race processor Ids

Throws:

NotFoundException - pollsId is not found

NullArgumentException - pollsId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getRaceProcessorsByPolls

RaceProcessorList getRaceProcessorsByPolls(Id pollsId)
                                           throws NotFoundException,
                                                  OperationFailedException,
                                                  PermissionDeniedException

Gets the list of race processors associated with a Polls.

Parameters:

pollsId - Id of the Polls

Returns:

list of related race processors

Throws:

NotFoundException - pollsId is not found

NullArgumentException - pollsId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getRaceProcessorIdsByPolls

IdList getRaceProcessorIdsByPolls(IdList pollsIds)
                                  throws OperationFailedException,
                                         PermissionDeniedException

Gets the list of RaceProcessor Ids corresponding to a list of Polls.

Parameters:

pollsIds - list of polls Ids

Returns:

list of race processor Ids

Throws:

NullArgumentException - pollsIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getRaceProcessorsByPolls

RaceProcessorList getRaceProcessorsByPolls(IdList pollsIds)
                                           throws OperationFailedException,
                                                  PermissionDeniedException

Gets the list of race processor corresponding to a list of Polls.

Parameters:

pollsIds - list of polls Ids

Returns:

list of race processors

Throws:

NullArgumentException - pollsIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getPollsIdsByRaceProcessor

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

Gets the Polls Ids mapped to a RaceProcessor.

Parameters:

raceProcessorId - Id of a RaceProcessor

Returns:

list of polls

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.

getPollsByRaceProcessor

PollsList getPollsByRaceProcessor(Id raceProcessorId)
                                  throws NotFoundException,
                                         OperationFailedException,
                                         PermissionDeniedException

Gets the Polls mapped to a RaceProcessor.

Parameters:

raceProcessorId - Id of a RaceProcessor

Returns:

list of polls

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.