org.osid.voting.rules

Interface RaceConstrainerEnablerPollsSession

All Superinterfaces:

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

public interface RaceConstrainerEnablerPollsSession
extends OsidSession

This session provides methods to retrieve RaceConstrainerEnabler to Polls mappings. a RaceConstrainerEnabler 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	canLookupRaceConstrainerEnablerPollsMappings() Tests if this user can perform lookups of race constrainer enabler/polls mappings.
PollsList	getPollsByRaceConstrainerEnabler(Id raceConstrainerEnablerId) Gets the Polls mapped to a RaceConstrainerEnabler.
IdList	getPollsIdsByRaceConstrainerEnabler(Id raceConstrainerEnablerId) Gets the Polls Ids mapped to a RaceConstrainerEnabler.
IdList	getRaceConstrainerEnablerIdsByPolls(Id pollsId) Gets the list of RaceConstrainerEnablerIds associated with a Polls.
IdList	getRaceConstrainerEnablerIdsByPolls(IdList pollsIds) Gets the list of RaceConstrainerEnabler Ids corresponding to a list of Polls.
RaceConstrainerEnablerList	getRaceConstrainerEnablersByPolls(Id pollsId) Gets the list of race constrainer enablers associated with a Polls.
RaceConstrainerEnablerList	getRaceConstrainerEnablersByPolls(IdList pollsIds) Gets the list of race constrainer enablers corresponding to a list of Polls.
void	useComparativeRaceConstrainerEnablerPollsView() 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	usePlenaryRaceConstrainerEnablerPollsView() A complete view of the RaceConstrainerEnabler 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

canLookupRaceConstrainerEnablerPollsMappings

boolean canLookupRaceConstrainerEnablerPollsMappings()

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

useComparativeRaceConstrainerEnablerPollsView

void useComparativeRaceConstrainerEnablerPollsView()

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.

usePlenaryRaceConstrainerEnablerPollsView

void usePlenaryRaceConstrainerEnablerPollsView()

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

getRaceConstrainerEnablerIdsByPolls

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

Gets the list of RaceConstrainerEnablerIds associated with a Polls.

Parameters:

pollsId - Id of the Polls

Returns:

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

getRaceConstrainerEnablersByPolls

RaceConstrainerEnablerList getRaceConstrainerEnablersByPolls(Id pollsId)
                                                             throws NotFoundException,
                                                                    OperationFailedException,
                                                                    PermissionDeniedException

Gets the list of race constrainer enablers associated with a Polls.

Parameters:

pollsId - Id of the Polls

Returns:

list of related race constrainer enablers

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.

getRaceConstrainerEnablerIdsByPolls

IdList getRaceConstrainerEnablerIdsByPolls(IdList pollsIds)
                                           throws OperationFailedException,
                                                  PermissionDeniedException

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

Parameters:

pollsIds - list of polls Ids

Returns:

list of race constrainer enabler Ids

Throws:

NullArgumentException - pollsIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getRaceConstrainerEnablersByPolls

RaceConstrainerEnablerList getRaceConstrainerEnablersByPolls(IdList pollsIds)
                                                             throws OperationFailedException,
                                                                    PermissionDeniedException

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

Parameters:

pollsIds - list of polls Ids

Returns:

list of race constrainer enablers

Throws:

NullArgumentException - pollsIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getPollsIdsByRaceConstrainerEnabler

IdList getPollsIdsByRaceConstrainerEnabler(Id raceConstrainerEnablerId)
                                           throws NotFoundException,
                                                  OperationFailedException,
                                                  PermissionDeniedException

Gets the Polls Ids mapped to a RaceConstrainerEnabler.

Parameters:

raceConstrainerEnablerId - Id of a RaceConstrainerEnabler

Returns:

list of polls

Throws:

NotFoundException - raceConstrainerEnablerId is not found

NullArgumentException - raceConstrainerEnablerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getPollsByRaceConstrainerEnabler

PollsList getPollsByRaceConstrainerEnabler(Id raceConstrainerEnablerId)
                                           throws NotFoundException,
                                                  OperationFailedException,
                                                  PermissionDeniedException

Gets the Polls mapped to a RaceConstrainerEnabler.

Parameters:

raceConstrainerEnablerId - Id of a RaceConstrainerEnabler

Returns:

list of polls

Throws:

NotFoundException - raceConstrainerEnablerId is not found

NullArgumentException - raceConstrainerEnablerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.