Interface VotePollsSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface VotePollsSession
extends OsidSession

This session provides methods to retrieve Vote to Polls mappings. A Vote 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	canLookupVotePollsMappings()	Tests if this user can perform lookups of vote/polls mappings.
PollsList	getPollsByVote(Id voteId)	Gets the list of Polls objects mapped to a Vote .
IdList	getPollsIdsByVote(Id voteId)	Gets the list of Polls Ids mapped to a Vote .
IdList	getVoteIdsByPolls(Id pollsId)	Gets the list of Vote Ids associated with a Polls .
VoteList	getVotesByPolls(Id pollsId)	Gets the list of Votess associated with a Polls .
VoteList	getVotesByPolls(IdList pollsIds)	Gets the list of Votes corresponding to a list of Polls .
IdList	getVotesIdsByPolls(IdList pollsIds)	Gets the list of Vote Ids corresponding to a list of Polls objects.
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 Vote 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 Vote 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.

canLookupVotePollsMappings

boolean canLookupVotePollsMappings()

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

getVoteIdsByPolls

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

Gets the list of Vote Ids associated with a Polls .

Parameters:

pollsId - Id of a Polls

Returns:

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

getVotesByPolls

VoteList getVotesByPolls(Id pollsId)
                  throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the list of Votess associated with a Polls .

Parameters:

pollsId - Id of a Polls

Returns:

list of related vote

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.

getVotesIdsByPolls

IdList getVotesIdsByPolls(IdList pollsIds)
                   throws OperationFailedException,
PermissionDeniedException

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

Parameters:

pollsIds - list of polls Ids

Returns:

list of vote Ids

Throws:

NullArgumentException - pollsIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getVotesByPolls

VoteList getVotesByPolls(IdList pollsIds)
                  throws OperationFailedException,
PermissionDeniedException

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

Parameters:

pollsIds - list of polls Ids

Returns:

list of votes

Throws:

NullArgumentException - pollsIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getPollsIdsByVote

IdList getPollsIdsByVote(Id voteId)
                  throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the list of Polls Ids mapped to a Vote .

Parameters:

voteId - Id of a Vote

Returns:

list of polls Ids

Throws:

NotFoundException - voteId is not found

NullArgumentException - voteId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getPollsByVote

PollsList getPollsByVote(Id voteId)
                  throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the list of Polls objects mapped to a Vote .

Parameters:

voteId - Id of a Vote

Returns:

list of polls

Throws:

NotFoundException - voteId is not found

NullArgumentException - voteId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.