org.osid.voting.rules

Interface RaceConstrainerEnablerPollsAssignmentSession

All Superinterfaces:

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

public interface RaceConstrainerEnablerPollsAssignmentSession
extends OsidSession

This session provides methods to re-assign RaceConstrainerEnabler to Polls mappings. a RaceConstrainerEnabler may appear in multiple Polls objects and removing the last reference to a RaceConstrainerEnabler 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 RaceConstrainerEnabler to another Polls is not a copy operation (eg: does not change its Id ).

Method Summary

Methods

Modifier and Type	Method and Description
void	assignRaceConstrainerEnablerToPolls(Id raceConstrainerEnablerId, Id pollsId) Adds an existing RaceConstrainerEnabler to a Polls.
boolean	canAssignRaceConstrainerEnablers() Tests if this user can alter race constrainer enabler/polls mappings.
boolean	canAssignRaceConstrainerEnablersToPolls(Id pollsId) Tests if this user can alter race constrainer enabler/polls mappings.
IdList	getAssignablePollsIds(Id pollsId) Gets a list of polls including and under the given polls node in which any race constrainer enabler can be assigned.
IdList	getAssignablePollsIdsForRaceConstrainerEnabler(Id pollsId, Id raceConstrainerEnablerId) Gets a list of polls including and under the given polls node in which a specific race constrainer enabler can be assigned.
void	reassignRaceConstrainerEnablerToPolls(Id raceConstrainerEnablerId, Id fromPollsId, Id toPollsId) Moves a RaceConstrainerEnabler from one Polls to another.
void	unassignRaceConstrainerEnablerFromPolls(Id raceConstrainerEnablerId, Id pollsId) Removes a RaceConstrainerEnabler 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

canAssignRaceConstrainerEnablers

boolean canAssignRaceConstrainerEnablers()

Tests if this user can alter race 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.

canAssignRaceConstrainerEnablersToPolls

boolean canAssignRaceConstrainerEnablersToPolls(Id pollsId)

Tests if this user can alter race 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 race 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.

getAssignablePollsIdsForRaceConstrainerEnabler

IdList getAssignablePollsIdsForRaceConstrainerEnabler(Id pollsId,
                                                    Id raceConstrainerEnablerId)
                                                      throws OperationFailedException

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

Parameters:

pollsId - the Id of the Polls

raceConstrainerEnablerId - the Id of the RaceConstrainerEnabler

Returns:

list of assignable polls Ids

Throws:

NullArgumentException - pollsId or raceConstrainerEnablerId is null

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

assignRaceConstrainerEnablerToPolls

void assignRaceConstrainerEnablerToPolls(Id raceConstrainerEnablerId,
                                       Id pollsId)
                                         throws AlreadyExistsException,
                                                NotFoundException,
                                                OperationFailedException,
                                                PermissionDeniedException

Adds an existing RaceConstrainerEnabler to a Polls.

Parameters:

raceConstrainerEnablerId - the Id of the RaceConstrainerEnabler

pollsId - the Id of the Polls

Throws:

AlreadyExistsException - raceConstrainerEnablerId is already assigned to pollsId

NotFoundException - raceConstrainerEnablerId or pollsId not found

NullArgumentException - raceConstrainerEnablerId or pollsId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

unassignRaceConstrainerEnablerFromPolls

void unassignRaceConstrainerEnablerFromPolls(Id raceConstrainerEnablerId,
                                           Id pollsId)
                                             throws NotFoundException,
                                                    OperationFailedException,
                                                    PermissionDeniedException

Removes a RaceConstrainerEnabler from a Polls.

Parameters:

raceConstrainerEnablerId - the Id of the RaceConstrainerEnabler

pollsId - the Id of the Polls

Throws:

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

NullArgumentException - raceConstrainerEnablerId or pollsId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

reassignRaceConstrainerEnablerToPolls

void reassignRaceConstrainerEnablerToPolls(Id raceConstrainerEnablerId,
                                         Id fromPollsId,
                                         Id toPollsId)
                                           throws NotFoundException,
                                                  OperationFailedException,
                                                  PermissionDeniedException

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

Parameters:

raceConstrainerEnablerId - the Id of the RaceConstrainerEnabler

fromPollsId - the Id of the current Polls

toPollsId - the Id of the destination Polls

Throws:

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

NullArgumentException - raceConstrainerEnablerId, fromPollsId, or toPollsId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.