OSID Logo
OSID Specifications
voting rules package
Version 3.0.0
Release Candidate Preview
Interfaceosid.voting.rules.RaceProcessorEnablerPollsAssignmentSession
Implementsosid.OsidSession
Description

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 ).

MethodcanAssignRaceProcessorEnablers
Description

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.

Returnboolean false if mapping is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodcanAssignRaceProcessorEnablersToPolls
Description

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.

Parametersosid.id.IdpollsIdthe Id of the Polls
Returnboolean false if mapping is not authorized, true otherwise
ErrorsNULL_ARGUMENT pollsId is null
CompliancemandatoryThis method must be implemented.
MethodgetAssignablePollsIds
Description

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

Parametersosid.id.IdpollsIdthe Id of the Polls
Returnosid.id.IdListlist of assignable polls Ids
ErrorsNULL_ARGUMENT pollsId is null
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetAssignablePollsIdsForRaceProcessorEnabler
Description

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

Parametersosid.id.IdpollsIdthe Id of the Polls
osid.id.IdraceProcessorEnablerIdthe Id of the RaceProcessorEnabler
Returnosid.id.IdListlist of assignable polls Ids
ErrorsNULL_ARGUMENT pollsId or raceProcessorEnablerId is null
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodassignRaceProcessorEnablerToPolls
Description

Adds an existing RaceProcessorEnabler to a Polls.

Parametersosid.id.IdraceProcessorEnablerIdthe Id of the RaceProcessorEnabler
osid.id.IdpollsIdthe Id of the Polls
ErrorsALREADY_EXISTS raceProcessorEnablerId is already assigned to pollsId
NOT_FOUND raceProcessorEnablerId or pollsId not found
NULL_ARGUMENT raceProcessorEnablerId or pollsId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodunassignRaceProcessorEnablerFromPolls
Description

Removes a RaceProcessorEnabler from a Polls.

Parametersosid.id.IdraceProcessorEnablerIdthe Id of the RaceProcessorEnabler
osid.id.IdpollsIdthe Id of the Polls
ErrorsNOT_FOUND raceProcessorEnablerId or pollsId not found or raceProcessorEnablerId not assigned to pollsId
NULL_ARGUMENT raceProcessorEnablerId or pollsId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodreassignRaceProcessorEnablerToPolls
Description

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

Parametersosid.id.IdraceProcessorEnablerIdthe Id of the RaceProcessorEnabler
osid.id.IdfromPollsIdthe Id of the current Polls
osid.id.IdtoPollsIdthe Id of the destination Polls
ErrorsNOT_FOUND raceProcessorEnablerId, fromPollsId, or toPollsId not found or raceProcessorEnablerId not mapped to fromPollsId
NULL_ARGUMENT raceProcessorEnablerId, fromPollsId, or toPollsId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.