Interface VoteEnablerPollsSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface VoteEnablerPollsSession
extends OsidSession

This session provides methods to retrieve VoteEnabler to Polls mappings. A VoteEnabler may appear in multiple Polls objects. Ea ch 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	canLookupVoteEnablerPollsMappings()	Tests if this user can perform lookups of vote enabler/polls mappings.
PollsList	getPollsByVoteEnabler(Id voteEnablerId)	Gets the Polls mapped to a VoteEnabler .
IdList	getPollsIdsByVoteEnabler(Id voteEnablerId)	Gets the Polls Ids mapped to a VoteEnabler .
IdList	getVoteEnablerIdsByPolls(Id pollsId)	Gets the list of VoteEnabler Ids associated with a Polls .
IdList	getVoteEnablerIdsByPolls(IdList pollsIds)	Gets the list of VoteEnabler Ids corresponding to a list of Polls .
VoteEnablerList	getVoteEnablersByPolls(Id pollsId)	Gets the list of VoteEnablers associated with a Polls .
VoteEnablerList	getVoteEnablersByPolls(IdList pollsIds)	Gets the list of VoteEnablers corresponding to a list of Polls .
void	useComparativeVoteEnablerPollsView()	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	usePlenaryVoteEnablerPollsView()	A complete view of the VoteEnabler 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

canLookupVoteEnablerPollsMappings

boolean canLookupVoteEnablerPollsMappings()

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

useComparativeVoteEnablerPollsView

void useComparativeVoteEnablerPollsView()

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.

usePlenaryVoteEnablerPollsView

void usePlenaryVoteEnablerPollsView()

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

getVoteEnablerIdsByPolls

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

Gets the list of VoteEnabler Ids associated with a Polls .

Parameters:

pollsId - Id of the Polls

Returns:

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

getVoteEnablersByPolls

VoteEnablerList getVoteEnablersByPolls(Id pollsId)
                                throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the list of VoteEnablers associated with a Polls .

Parameters:

pollsId - Id of the Polls

Returns:

list of related vote enablers

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.

getVoteEnablerIdsByPolls

IdList getVoteEnablerIdsByPolls(IdList pollsIds)
                         throws OperationFailedException,
PermissionDeniedException

Gets the list of VoteEnabler Ids corresponding to a list of Polls .

Parameters:

pollsIds - list of polls Ids

Returns:

list of vote enabler Ids

Throws:

NullArgumentException - pollsIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getVoteEnablersByPolls

VoteEnablerList getVoteEnablersByPolls(IdList pollsIds)
                                throws OperationFailedException,
PermissionDeniedException

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

Parameters:

pollsIds - list of polls Ids

Returns:

list of vote enablers

Throws:

NullArgumentException - pollsIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getPollsIdsByVoteEnabler

IdList getPollsIdsByVoteEnabler(Id voteEnablerId)
                         throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the Polls Ids mapped to a VoteEnabler .

Parameters:

voteEnablerId - Id of a VoteEnabler

Returns:

list of polls Ids

Throws:

NotFoundException - voteEnablerId is not found

NullArgumentException - voteEnablerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getPollsByVoteEnabler

PollsList getPollsByVoteEnabler(Id voteEnablerId)
                         throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the Polls mapped to a VoteEnabler .

Parameters:

voteEnablerId - Id of a VoteEnabler

Returns:

list of polls

Throws:

NotFoundException - voteEnablerId is not found

NullArgumentException - voteEnablerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.