Interface CandidatePollsSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface CandidatePollsSession
extends OsidSession

This session provides methods to retrieve Candidate to Polls mappings. A Candidate 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	canLookupCandidatePollsMappings()	Tests if this user can perform lookups of candidate/polls mappings.
IdList	getCandidateIdsByPolls(Id pollsId)	Gets the list of Candidate Ids associated with a Polls .
IdList	getCandidateIdsByPolls(IdList pollsIds)	Gets the list of Candidate Ids corresponding to a list of Polls objects.
CandidateList	getCandidatesByPolls(Id pollsId)	Gets the list of Candidates associated with a Polls .
CandidateList	getCandidatesByPolls(IdList pollsIds)	Gets the list of Candidates corresponding to a list of Polls .
PollsList	getPollsByCandidate(Id candidateId)	Gets the list of Polls objects mapped to a Candidate .
IdList	getPollsIdsByCandidate(Id candidateId)	Gets the list of Polls Ids mapped to a Candidate .
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 Candidate 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 Candidate 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.

canLookupCandidatePollsMappings

boolean canLookupCandidatePollsMappings()

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

getCandidateIdsByPolls

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

Gets the list of Candidate Ids associated with a Polls .

Parameters:

pollsId - Id of a Polls

Returns:

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

getCandidatesByPolls

CandidateList getCandidatesByPolls(Id pollsId)
                            throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the list of Candidates associated with a Polls .

Parameters:

pollsId - Id of a Polls

Returns:

list of related candidates

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.

getCandidateIdsByPolls

IdList getCandidateIdsByPolls(IdList pollsIds)
                       throws OperationFailedException,
PermissionDeniedException

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

Parameters:

pollsIds - list of polls Ids

Returns:

list of candidate Ids

Throws:

NullArgumentException - pollsIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getCandidatesByPolls

CandidateList getCandidatesByPolls(IdList pollsIds)
                            throws OperationFailedException,
PermissionDeniedException

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

Parameters:

pollsIds - list of polls Ids

Returns:

list of candidates

Throws:

NullArgumentException - pollsIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getPollsIdsByCandidate

IdList getPollsIdsByCandidate(Id candidateId)
                       throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the list of Polls Ids mapped to a Candidate .

Parameters:

candidateId - Id of a Candidate

Returns:

list of polls Ids

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.

getPollsByCandidate

PollsList getPollsByCandidate(Id candidateId)
                       throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the list of Polls objects mapped to a Candidate .

Parameters:

candidateId - Id of a Candidate

Returns:

list of polls

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.