org.osid.voting.rules

Interface RaceConstrainerPollsSession

All Superinterfaces:

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

public interface RaceConstrainerPollsSession
extends OsidSession

This session provides methods to retrieve RaceConstrainer to Polls mappings. a RaceConstrainer 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	canLookupRaceConstrainerPollsMappings() Tests if this user can perform lookups of race constrainer/polls mappings.
PollsList	getPollsByRaceConstrainer(Id raceConstrainerId) Gets the Polls mapped to a RaceConstrainer.
IdList	getPollsIdsByRaceConstrainer(Id raceConstrainerId) Gets the Polls Ids mapped to a RaceConstrainer.
IdList	getRaceConstrainerIdsByPolls(Id pollsId) Gets the list of RaceConstrainerIds associated with a Polls.
IdList	getRaceConstrainerIdsByPolls(IdList pollsIds) Gets the list of RaceConstrainer Ids corresponding to a list of Polls.
RaceConstrainerList	getRaceConstrainersByPolls(Id pollsId) Gets the list of race constrainer associated with a Polls.
RaceConstrainerList	getRaceConstrainersByPolls(IdList pollsIds) Gets the list of race constrainer corresponding to a list of Polls.
void	useComparativeRaceConstrainerPollsView() 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	usePlenaryRaceConstrainerPollsView() A complete view of the RaceConstrainer 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

canLookupRaceConstrainerPollsMappings

boolean canLookupRaceConstrainerPollsMappings()

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

useComparativeRaceConstrainerPollsView

void useComparativeRaceConstrainerPollsView()

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.

usePlenaryRaceConstrainerPollsView

void usePlenaryRaceConstrainerPollsView()

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

getRaceConstrainerIdsByPolls

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

Gets the list of RaceConstrainerIds associated with a Polls.

Parameters:

pollsId - Id of the Polls

Returns:

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

getRaceConstrainersByPolls

RaceConstrainerList getRaceConstrainersByPolls(Id pollsId)
                                               throws NotFoundException,
                                                      OperationFailedException,
                                                      PermissionDeniedException

Gets the list of race constrainer associated with a Polls.

Parameters:

pollsId - Id of the Polls

Returns:

list of related race constrainers

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.

getRaceConstrainerIdsByPolls

IdList getRaceConstrainerIdsByPolls(IdList pollsIds)
                                    throws OperationFailedException,
                                           PermissionDeniedException

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

Parameters:

pollsIds - list of polls Ids

Returns:

list of race constrainer Ids

Throws:

NullArgumentException - pollsIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getRaceConstrainersByPolls

RaceConstrainerList getRaceConstrainersByPolls(IdList pollsIds)
                                               throws OperationFailedException,
                                                      PermissionDeniedException

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

Parameters:

pollsIds - list of polls Ids

Returns:

list of race constrainers

Throws:

NullArgumentException - pollsIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getPollsIdsByRaceConstrainer

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

Gets the Polls Ids mapped to a RaceConstrainer.

Parameters:

raceConstrainerId - Id of a RaceConstrainer

Returns:

list of polls

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.

getPollsByRaceConstrainer

PollsList getPollsByRaceConstrainer(Id raceConstrainerId)
                                    throws NotFoundException,
                                           OperationFailedException,
                                           PermissionDeniedException

Gets the Polls mapped to a RaceConstrainer.

Parameters:

raceConstrainerId - Id of a RaceConstrainer

Returns:

list of polls

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.