org.osid.voting.rules

Interface RaceProcessorEnablerPollsAssignmentSession

All Superinterfaces:

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

public interface RaceProcessorEnablerPollsAssignmentSession
extends OsidSession

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

Method Summary

Methods

Modifier and Type	Method and Description
void	assignRaceProcessorEnablerToPolls(Id raceProcessorEnablerId, Id pollsId) Adds an existing RaceProcessorEnabler to a Polls.
boolean	canAssignRaceProcessorEnablers() Tests if this user can alter race processor enabler/polls mappings.
boolean	canAssignRaceProcessorEnablersToPolls(Id pollsId) Tests if this user can alter race processor enabler/polls mappings.
IdList	getAssignablePollsIds(Id pollsId) Gets a list of polls including and under the given polls node in which any race processor enabler can be assigned.
IdList	getAssignablePollsIdsForRaceProcessorEnabler(Id pollsId, Id raceProcessorEnablerId) Gets a list of polls including and under the given polls node in which a specific race processor enabler can be assigned.
void	reassignRaceProcessorEnablerToPolls(Id raceProcessorEnablerId, Id fromPollsId, Id toPollsId) Moves a RaceProcessorEnabler from one Polls to another.
void	unassignRaceProcessorEnablerFromPolls(Id raceProcessorEnablerId, Id pollsId) Removes a RaceProcessorEnabler 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

canAssignRaceProcessorEnablers

boolean canAssignRaceProcessorEnablers()

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

canAssignRaceProcessorEnablersToPolls

boolean canAssignRaceProcessorEnablersToPolls(Id pollsId)

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

getAssignablePollsIdsForRaceProcessorEnabler

IdList getAssignablePollsIdsForRaceProcessorEnabler(Id pollsId,
                                                  Id raceProcessorEnablerId)
                                                    throws OperationFailedException

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

Parameters:

pollsId - the Id of the Polls

raceProcessorEnablerId - the Id of the RaceProcessorEnabler

Returns:

list of assignable polls Ids

Throws:

NullArgumentException - pollsId or raceProcessorEnablerId is null

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

assignRaceProcessorEnablerToPolls

void assignRaceProcessorEnablerToPolls(Id raceProcessorEnablerId,
                                     Id pollsId)
                                       throws AlreadyExistsException,
                                              NotFoundException,
                                              OperationFailedException,
                                              PermissionDeniedException

Adds an existing RaceProcessorEnabler to a Polls.

Parameters:

raceProcessorEnablerId - the Id of the RaceProcessorEnabler

pollsId - the Id of the Polls

Throws:

AlreadyExistsException - raceProcessorEnablerId is already assigned to pollsId

NotFoundException - raceProcessorEnablerId or pollsId not found

NullArgumentException - raceProcessorEnablerId or pollsId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

unassignRaceProcessorEnablerFromPolls

void unassignRaceProcessorEnablerFromPolls(Id raceProcessorEnablerId,
                                         Id pollsId)
                                           throws NotFoundException,
                                                  OperationFailedException,
                                                  PermissionDeniedException

Removes a RaceProcessorEnabler from a Polls.

Parameters:

raceProcessorEnablerId - the Id of the RaceProcessorEnabler

pollsId - the Id of the Polls

Throws:

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

NullArgumentException - raceProcessorEnablerId or pollsId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

reassignRaceProcessorEnablerToPolls

void reassignRaceProcessorEnablerToPolls(Id raceProcessorEnablerId,
                                       Id fromPollsId,
                                       Id toPollsId)
                                         throws NotFoundException,
                                                OperationFailedException,
                                                PermissionDeniedException

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

Parameters:

raceProcessorEnablerId - the Id of the RaceProcessorEnabler

fromPollsId - the Id of the current Polls

toPollsId - the Id of the destination Polls

Throws:

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

NullArgumentException - raceProcessorEnablerId, fromPollsId, or toPollsId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.