org.osid.voting.rules

Interface BallotConstrainerEnablerPollsAssignmentSession

All Superinterfaces:

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

public interface BallotConstrainerEnablerPollsAssignmentSession
extends OsidSession

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

Adding a reference of a BallotConstrainerEnabler to another Polls is not a copy operation (eg: does not change its Id ).

Method Summary

Methods

Modifier and Type	Method and Description
void	assignBallotConstrainerEnablerToPolls(Id ballotConstrainerEnablerId, Id pollsId) Adds an existing BallotConstrainerEnabler to a Polls.
boolean	canAssignBallotConstrainerEnablers() Tests if this user can alter ballot constrainer enabler/polls mappings.
boolean	canAssignBallotConstrainerEnablersToPolls(Id pollsId) Tests if this user can alter ballot constrainer enabler/polls mappings.
IdList	getAssignablePollsIds(Id pollsId) Gets a list of polls including and under the given polls node in which any ballot constrainer enabler can be assigned.
IdList	getAssignablePollsIdsForBallotConstrainerEnabler(Id pollsId, Id ballotConstrainerEnablerId) Gets a list of polls including and under the given polls node in which a specific ballot constrainer enabler can be assigned.
void	reassignBallotConstrainerEnablerToPolls(Id ballotConstrainerEnablerId, Id fromPollsId, Id toPollsId) Moves a BallotConstrainerEnabler from one Polls to another.
void	unassignBallotConstrainerEnablerFromPolls(Id ballotConstrainerEnablerId, Id pollsId) Removes a BallotConstrainerEnabler 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

canAssignBallotConstrainerEnablers

boolean canAssignBallotConstrainerEnablers()

Tests if this user can alter ballot constrainer enabler/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 lookup operations to unauthorized users.

Returns:

false if mapping is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

canAssignBallotConstrainerEnablersToPolls

boolean canAssignBallotConstrainerEnablersToPolls(Id pollsId)

Tests if this user can alter ballot constrainer enabler/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 lookup 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 constrainer enabler 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.

getAssignablePollsIdsForBallotConstrainerEnabler

IdList getAssignablePollsIdsForBallotConstrainerEnabler(Id pollsId,
                                                      Id ballotConstrainerEnablerId)
                                                        throws OperationFailedException

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

Parameters:

pollsId - the Id of the Polls

ballotConstrainerEnablerId - the Id of the BallotConstrainerEnabler

Returns:

list of assignable polls Ids

Throws:

NullArgumentException - pollsId or ballotConstrainerEnablerId is null

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

assignBallotConstrainerEnablerToPolls

void assignBallotConstrainerEnablerToPolls(Id ballotConstrainerEnablerId,
                                         Id pollsId)
                                           throws AlreadyExistsException,
                                                  NotFoundException,
                                                  OperationFailedException,
                                                  PermissionDeniedException

Adds an existing BallotConstrainerEnabler to a Polls.

Parameters:

ballotConstrainerEnablerId - the Id of the BallotConstrainerEnabler

pollsId - the Id of the Polls

Throws:

AlreadyExistsException - ballotConstrainerEnablerId is already assigned to pollsId

NotFoundException - ballotConstrainerEnablerId or pollsId not found

NullArgumentException - ballotConstrainerEnablerId or pollsId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

unassignBallotConstrainerEnablerFromPolls

void unassignBallotConstrainerEnablerFromPolls(Id ballotConstrainerEnablerId,
                                             Id pollsId)
                                               throws NotFoundException,
                                                      OperationFailedException,
                                                      PermissionDeniedException

Removes a BallotConstrainerEnabler from a Polls.

Parameters:

ballotConstrainerEnablerId - the Id of the BallotConstrainerEnabler

pollsId - the Id of the Polls

Throws:

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

NullArgumentException - ballotConstrainerEnablerId or pollsId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

reassignBallotConstrainerEnablerToPolls

void reassignBallotConstrainerEnablerToPolls(Id ballotConstrainerEnablerId,
                                           Id fromPollsId,
                                           Id toPollsId)
                                             throws NotFoundException,
                                                    OperationFailedException,
                                                    PermissionDeniedException

Moves a BallotConstrainerEnabler from one Polls to another. Mappings to other Polls are unaffected.

Parameters:

ballotConstrainerEnablerId - the Id of the BallotConstrainerEnabler

fromPollsId - the Id of the current Polls

toPollsId - the Id of the destination Polls

Throws:

NotFoundException - ballotConstrainerEnablerId, fromPollsId, or toPollsId not found or ballotConstrainerEnablerId not mapped to fromPollsId

NullArgumentException - BallotConstrainerEnablerId, fromPollsId, or toPollsId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.