Interface BallotPollsSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface BallotPollsSession
extends OsidSession

This session provides methods to retrieve Ballot to Polls mappings. A Ballot may appear in multiple Polls . 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

Modifier and Type	Method	Description
boolean	canLookupBallotPollsMappings()	Tests if this user can perform lookups of ballot/polls mappings.
IdList	getBallotIdsByPolls(Id pollsId)	Gets the list of Ballot Ids associated with a Polls .
IdList	getBallotIdsByPolls(IdList pollsIds)	Gets the list of Ballot Ids corresponding to a list of Polls objects.
BallotList	getBallotsByPolls(Id pollsId)	Gets the list of Ballots associated with a Polls .
BallotList	getBallotsByPolls(IdList pollsIds)	Gets the list of Ballots corresponding to a list of Polls .
PollsList	getPollsByBallot(Id ballotId)	Gets the list of Polls objects mapped to a Ballot .
IdList	getPollsIdsByBallot(Id ballotId)	Gets the list of Polls Ids mapped to a Ballot .
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 Ballot and Polls returns is desired.

Methods inherited from interface Closeable

close

Methods inherited from interface OsidSession

close

Modifier and Type	Method	Description
void	close()	Close this session.

Methods inherited from interface OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Modifier and Type	Method	Description
Agent	getAuthenticatedAgent()	Gets the agent authenticated to this session.
Id	getAuthenticatedAgentId()	Gets the Id of the agent authenticated to this session.
BigDecimal	getClockRate()	Gets the rate of the service clock.
Date	getDate()	Gets the service date which may be the current date or the effective date in which this session exists.
Agent	getEffectiveAgent()	Gets the effective agent in use by this session.
Id	getEffectiveAgentId()	Gets the Id of the effective agent in use by this session.
Type	getFormatType()	Gets the DisplayText format Type preference in effect for this session.
Locale	getLocale()	Gets the locale indicating the localization preferences in effect for this session.
boolean	isAuthenticated()	Tests if an agent is authenticated to this session.
Transaction	startTransaction()	Starts a new transaction for this sesson.
boolean	supportsTransactions()	Tests for the availability of transactions.

Method Details

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 Ballot 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.

canLookupBallotPollsMappings

boolean canLookupBallotPollsMappings()

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

getBallotIdsByPolls

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

Gets the list of Ballot Ids associated with a Polls .

Parameters:

pollsId - Id of a Polls

Returns:

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

getBallotsByPolls

BallotList getBallotsByPolls(Id pollsId)
                      throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the list of Ballots associated with a Polls .

Parameters:

pollsId - Id of a Polls

Returns:

list of related ballots

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.

getBallotIdsByPolls

IdList getBallotIdsByPolls(IdList pollsIds)
                    throws OperationFailedException,
PermissionDeniedException

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

Parameters:

pollsIds - list of polls Ids

Returns:

list of ballot Ids

Throws:

NullArgumentException - pollsIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getBallotsByPolls

BallotList getBallotsByPolls(IdList pollsIds)
                      throws OperationFailedException,
PermissionDeniedException

Gets the list of Ballots corresponding to a list of Polls .

Parameters:

pollsIds - list of polls Ids

Returns:

list of ballots

Throws:

NullArgumentException - pollsIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getPollsIdsByBallot

IdList getPollsIdsByBallot(Id ballotId)
                    throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the list of Polls Ids mapped to a Ballot .

Parameters:

ballotId - Id of a Ballot

Returns:

list of polls Ids

Throws:

NotFoundException - ballotId is not found

NullArgumentException - ballotId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getPollsByBallot

PollsList getPollsByBallot(Id ballotId)
                    throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the list of Polls objects mapped to a Ballot .

Parameters:

ballotId - Id of a Ballot

Returns:

list of polls

Throws:

NotFoundException - ballotId is not found

NullArgumentException - ballotId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.