Interface BallotConstrainerPollsSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface BallotConstrainerPollsSession
extends OsidSession

This session provides methods to retrieve BallotConstrainer to Polls mappings. A BallotConstrainer 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

Modifier and Type	Method	Description
boolean	canLookupBallotConstrainerPollsMappings()	Tests if this user can perform lookups of ballot constrainer/polls mappings.
IdList	getBallotConstrainerIdsByPolls(Id pollsId)	Gets the list of BallotConstrainerIds associated with a Polls .
IdList	getBallotConstrainerIdsByPolls(IdList pollsIds)	Gets the list of BallotConstrainerIds corresponding to a list of Polls .
BallotConstrainerList	getBallotConstrainersByPolls(Id pollsId)	Gets the list of ballot constrainer associated with a Polls .
BallotConstrainerList	getBallotConstrainersByPolls(IdList pollsIds)	Gets the list of ballot constrainer corresponding to a list of Polls .
PollsList	getPollsByBallotConstrainer(Id ballotConstrainerId)	Gets the Polls mapped to a BallotConstrainer .
IdList	getPollsIdsByBallotConstrainer(Id ballotConstrainerId)	Gets the Polls Ids mapped to a BallotConstrainer .
void	useComparativeBallotConstrainerPollsView()	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	usePlenaryBallotConstrainerPollsView()	A complete view of the BallotConstrainer 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

canLookupBallotConstrainerPollsMappings

boolean canLookupBallotConstrainerPollsMappings()

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

useComparativeBallotConstrainerPollsView

void useComparativeBallotConstrainerPollsView()

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.

usePlenaryBallotConstrainerPollsView

void usePlenaryBallotConstrainerPollsView()

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

getBallotConstrainerIdsByPolls

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

Gets the list of BallotConstrainerIds associated with a Polls .

Parameters:

pollsId - Id of the Polls

Returns:

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

getBallotConstrainersByPolls

BallotConstrainerList getBallotConstrainersByPolls(Id pollsId)
                                            throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the list of ballot constrainer associated with a Polls .

Parameters:

pollsId - Id of the Polls

Returns:

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

getBallotConstrainerIdsByPolls

IdList getBallotConstrainerIdsByPolls(IdList pollsIds)
                               throws OperationFailedException,
PermissionDeniedException

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

Parameters:

pollsIds - list of polls Ids

Returns:

list of ballot constrainer Ids

Throws:

NullArgumentException - pollsIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getBallotConstrainersByPolls

BallotConstrainerList getBallotConstrainersByPolls(IdList pollsIds)
                                            throws OperationFailedException,
PermissionDeniedException

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

Parameters:

pollsIds - list of polls Ids

Returns:

list of ballot constrainers

Throws:

NullArgumentException - pollsIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getPollsIdsByBallotConstrainer

IdList getPollsIdsByBallotConstrainer(Id ballotConstrainerId)
                               throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the Polls Ids mapped to a BallotConstrainer .

Parameters:

ballotConstrainerId - Id of a BallotConstrainer

Returns:

list of polls

Throws:

NotFoundException - ballotConstrainerId is not found

NullArgumentException - ballotConstrainerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getPollsByBallotConstrainer

PollsList getPollsByBallotConstrainer(Id ballotConstrainerId)
                               throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the Polls mapped to a BallotConstrainer .

Parameters:

ballotConstrainerId - Id of a BallotConstrainer

Returns:

list of polls

Throws:

NotFoundException - ballotConstrainerId is not found

NullArgumentException - ballotConstrainerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.