Interface VoterAllocationLookupSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface VoterAllocationLookupSession
extends OsidSession

This session provides methods for looking up voter allocations.

This session defines views that offer differing behaviors when retrieving multiple objects.

• comparative view: elements may be silently omitted or re-ordered
• plenary view: provides a complete set or is an error condition

Method Summary

Modifier and Type	Method	Description
boolean	canLookupVoterAllocations()	Tests if this user can access voter allocations.
Polls	getPolls()	Gets the Polls associated with this session.
Id	getPollsId()	Gets the Polls Id associated with this session.
VoterAllocation	getVoterAllocation(Id raceId, Id resourceId)	Gets a VoterAllocation specified by the race and voter.
VoterAllocationList	getVoterAllocations()	Gets all VoterAllocations on this ballot.
VoterAllocationList	getVoterAllocationsByRace(Id raceId)	Gets the VoterAllocations in a race.
VoterAllocationList	getVoterAllocationsByRecordType(Type voterAllocationRecordType)	Gets the voter allocations for the voter allocation record type.
VoterAllocationList	getVoterAllocationsByVoter(Id resourceId)	Gets the VoterAllocations for a voter.
VoterAllocationList	getVoterAllocationsByVoterForBallot(Id ballotId, Id resourceId)	Gets the VoterAllocations for a voter on a ballot.
void	useComparativeVoterAllocationView()	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	usePlenaryVoterAllocationView()	A complete view of the voter allocation 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

getPollsId

Id getPollsId()

Gets the Polls Id associated with this session.

Returns:

the Polls Id associated with this session

Compliance:

mandatory - This method must be implemented.

getPolls

Polls getPolls()
        throws OperationFailedException,
PermissionDeniedException

Gets the Polls associated with this session.

Returns:

the polls

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canLookupVoterAllocations

boolean canLookupVoterAllocations()

Tests if this user can access voter allocations. A return of true does not guarantee successful authorization. A return of false indicates that it is known all 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 relationship operations.

Returns:

false if voter allocation lookup methods are not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

useComparativeVoterAllocationView

void useComparativeVoterAllocationView()

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.

usePlenaryVoterAllocationView

void usePlenaryVoterAllocationView()

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

getVoterAllocation

VoterAllocation getVoterAllocation(Id raceId,
 Id resourceId)
                            throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets a VoterAllocation specified by the race and voter.

Parameters:

raceId - Id of the Race

resourceId - Id of the Resource

Returns:

the voter allocation

Throws:

NotFoundException - raceId or resourceId not found

NullArgumentException - raceId or resourceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method is must be implemented.

getVoterAllocationsByRecordType

VoterAllocationList getVoterAllocationsByRecordType(Type voterAllocationRecordType)
                                             throws OperationFailedException,
PermissionDeniedException

Gets the voter allocations for the voter allocation record type. In plenary mode, the returned list contains all known allocations or an error results. Otherwise, the returned list may contain only those allocations that are accessible through this session.

Parameters:

voterAllocationRecordType - a voter allocation record type

Returns:

the voter allocations

Throws:

NullArgumentException - voterAllocationRecordType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getVoterAllocationsByRace

VoterAllocationList getVoterAllocationsByRace(Id raceId)
                                       throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the VoterAllocations in a race.

Parameters:

raceId - Id of a Race

Returns:

the voter allocations

Throws:

NotFoundException - candidateId is not found

NullArgumentException - candidateId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getVoterAllocationsByVoter

VoterAllocationList getVoterAllocationsByVoter(Id resourceId)
                                        throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the VoterAllocations for a voter.

Parameters:

resourceId - Id of a Resource

Returns:

the voter allocations

Throws:

NotFoundException - resourceId is not found

NullArgumentException - resourceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getVoterAllocationsByVoterForBallot

VoterAllocationList getVoterAllocationsByVoterForBallot(Id ballotId,
 Id resourceId)
                                                 throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the VoterAllocations for a voter on a ballot.

Parameters:

ballotId - Id of a Ballot

resourceId - Id of a Resource

Returns:

the voter allocations

Throws:

NotFoundException - ballotId or resourceId is not found

NullArgumentException - ballotId or resourceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getVoterAllocations

VoterAllocationList getVoterAllocations()
                                 throws OperationFailedException,
PermissionDeniedException

Gets all VoterAllocations on this ballot.

Returns:

the voter allocations

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.