org.osid.voting

Interface RacePollsSession

All Superinterfaces:

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

public interface RacePollsSession
extends OsidSession

This session provides methods to retrieve Race to Polls mappings. A Race may appear in multiple Polls objects. Each catalog 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	canLookupRacePollsMappings() Tests if this user can perform lookups of race/polls mappings.
PollsList	getPollsByRace(Id raceId) Gets the Polls objects mapped to a Race.
IdList	getPollsIdsByRace(Id raceId) Gets the Polls Ids mapped to a Race.
IdList	getRaceIdsByPolls(Id pollsId) Gets the list of Race Ids associated with a Polls.
IdList	getRaceIdsByPolls(IdList pollsIds) Gets the list of Race Ids corresponding to a list of Polls objects.
RaceList	getRacesByPolls(Id pollsId) Gets the list of Races associated with a Polls.
RaceList	getRacesByPolls(IdList pollsIds) Gets the list of Races corresponding to a list of Polls objects.
void	useComparativePollsView() 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	usePlenaryPollsView() A complete view of the Race 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

canLookupRacePollsMappings

boolean canLookupRacePollsMappings()

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

useComparativePollsView

void useComparativePollsView()

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.

usePlenaryPollsView

void usePlenaryPollsView()

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

getRaceIdsByPolls

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

Gets the list of Race Ids associated with a Polls.

Parameters:

pollsId - Id of the Polls

Returns:

list of related race 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.

getRacesByPolls

RaceList getRacesByPolls(Id pollsId)
                         throws NotFoundException,
                                OperationFailedException,
                                PermissionDeniedException

Gets the list of Races associated with a Polls.

Parameters:

pollsId - Id of the Polls

Returns:

list of related races

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.

getRaceIdsByPolls

IdList getRaceIdsByPolls(IdList pollsIds)
                         throws OperationFailedException,
                                PermissionDeniedException

Gets the list of Race Ids corresponding to a list of Polls objects.

Parameters:

pollsIds - list of polls Ids

Returns:

list of race Ids

Throws:

NullArgumentException - pollsIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getRacesByPolls

RaceList getRacesByPolls(IdList pollsIds)
                         throws OperationFailedException,
                                PermissionDeniedException

Gets the list of Races corresponding to a list of Polls objects.

Parameters:

pollsIds - list of polls Ids

Returns:

list of races

Throws:

NullArgumentException - pollsIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getPollsIdsByRace

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

Gets the Polls Ids mapped to a Race.

Parameters:

raceId - Id of a Race

Returns:

list of polls 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.

getPollsByRace

PollsList getPollsByRace(Id raceId)
                         throws NotFoundException,
                                OperationFailedException,
                                PermissionDeniedException

Gets the Polls objects mapped to a Race.

Parameters:

raceId - Id of a Race

Returns:

list of polls 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.