org.osid.voting

Interface BallotPollsAssignmentSession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidSession

public interface BallotPollsAssignmentSession
extends OsidSession

This session provides methods to re-assign Ballots to Polls. A Ballot may map to multiple Polls objects and removing the last reference to a Ballot is the equivalent of deleting it. Each Polls may have its own authorizations governing who is allowed to operate on it.

Moving or adding a reference of a Ballot to another Polls is not a copy operation (eg: does not change its Id ).

Method Summary

Methods

Modifier and Type	Method and Description
void	assignBallotToPolls(Id ballotId, Id pollsId) Adds an existing Ballot to a Polls.
boolean	canAssignBallots() Tests if this user can alter ballot/polls mappings.
boolean	canAssignBallotsToPolls(Id pollsId) Tests if this user can alter ballot/polls mappings.
IdList	getAssignablePollsIds(Id pollsId) Gets a list of polls including and under the given polls node in which any ballot can be assigned.
IdList	getAssignablePollsIdsForBallot(Id pollsId, Id ballotId) Gets a list of polls including and under the given polls node in which a specific ballot can be assigned.
void	unassignBallotFromPolls(Id ballotId, Id pollsId) Removes a Ballot from a Polls.

Methods inherited from interface org.osid.OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Methods inherited from interface org.osid.binding.java.OsidSession

close

Methods inherited from interface java.io.Closeable

close

Method Detail

canAssignBallots

boolean canAssignBallots()

Tests if this user can alter ballot/polls mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known mapping 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 assignment operations to unauthorized users.

Returns:

false if mapping is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

canAssignBallotsToPolls

boolean canAssignBallotsToPolls(Id pollsId)

Tests if this user can alter ballot/polls mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known mapping 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 assignment operations to unauthorized users.

Parameters:

pollsId - the Id of the Polls

Returns:

false if mapping is not authorized, true otherwise

Throws:

NullArgumentException - pollsId is null

Compliance:

mandatory - This method must be implemented.

getAssignablePollsIds

IdList getAssignablePollsIds(Id pollsId)
                             throws OperationFailedException

Gets a list of polls including and under the given polls node in which any ballot can be assigned.

Parameters:

pollsId - the Id of the Polls

Returns:

list of assignable polls Ids

Throws:

NullArgumentException - pollsId is null

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

getAssignablePollsIdsForBallot

IdList getAssignablePollsIdsForBallot(Id pollsId,
                                    Id ballotId)
                                      throws OperationFailedException

Gets a list of polls including and under the given polls node in which a specific ballot can be assigned.

Parameters:

pollsId - the Id of the Polls

ballotId - the Id of the Ballot

Returns:

list of assignable polls Ids

Throws:

NullArgumentException - pollsId or ballotId is null

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

assignBallotToPolls

void assignBallotToPolls(Id ballotId,
                       Id pollsId)
                         throws AlreadyExistsException,
                                NotFoundException,
                                OperationFailedException,
                                PermissionDeniedException

Adds an existing Ballot to a Polls.

Parameters:

ballotId - the Id of the Ballot

pollsId - the Id of the Polls

Throws:

AlreadyExistsException - ballotId is already assigned to pollsId

NotFoundException - ballotId or pollsId not found

NullArgumentException - ballotId or pollsId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

unassignBallotFromPolls

void unassignBallotFromPolls(Id ballotId,
                           Id pollsId)
                             throws NotFoundException,
                                    OperationFailedException,
                                    PermissionDeniedException

Removes a Ballot from a Polls.

Parameters:

ballotId - the Id of the Ballot

pollsId - the Id of the Polls

Throws:

NotFoundException - ballotId or pollsId not found or ballotId not assigned to pollsId

NullArgumentException - ballotId or pollsId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.