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

This session provides methods to apply RaceProcessorEnablers to RaceProcessors. a RaceProcessor with multiple RaceProcessorEnablers means any positive rule evaluation across the enablers result in an effective RaceProcessor.

MethodgetPollsId
Description

Gets the Polls Id associated with this session.

Returnosid.id.Idthe Polls Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetPolls
Description

Gets the Polls associated with this session.

Returnosid.voting.Pollsthe polls
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanAssignRaceProcessorEnablers
Description

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

Adds an existing RaceProcessorEnabler to a RaceProcessor.

Parametersosid.id.IdraceProcessorEnablerIdthe Id of the RaceProcessorEnabler
osid.id.IdraceProcessorIdthe Id of the RaceProcessor
ErrorsALREADY_EXISTS raceProcessorEnablerId is already applied to raceProcessorId
NOT_FOUND raceProcessorEnablerId or raceProcessorId not found
NULL_ARGUMENT raceProcessorEnablerId or raceProcessorId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodunassignRaceProcessorEnablerFromRaceProcessor
Description

Removes a RaceProcessorEnabler from a RaceProcessor.

Parametersosid.id.IdraceProcessorEnablerIdthe Id of the RaceProcessorEnabler
osid.id.IdraceProcessorIdthe Id of the RaceProcessor
ErrorsNOT_FOUND raceProcessorEnablerId or raceProcessorId not found or raceProcessorEnablerId not applied to raceProcessorId
NULL_ARGUMENT raceProcessorEnablerId or raceProcessorId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanSequenceRaceProcessorEnablers
Description

Tests if this user can order RaceProcessorEnablers. A return of true does not guarantee successful authorization. A return of false indicates that it is known sequencing operations will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer sequencing operations to an unauthorized user.

Returnboolean false if RaceProcessorEnabler ordering is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodmoveRaceProcessorEnablerAhead
Description

Reorders race processor enablers for a race processor by moving the specified race processor enabler in front of a reference race processor enabler.

Parametersosid.id.IdraceProcessorEnablerIdthe Id of a RaceProcessorEnabler
osid.id.IdraceProcessorIdthe Id of a RaceProcessor
osid.id.IdreferenceIdthe reference race processor enabler Id
ErrorsNOT_FOUND raceProcessorEnablerId, raceProcessorId, or referenceId not found or, raceProcessorEnablerId or referenceId not related to processorId
NULL_ARGUMENT raceProcessorEnablerId, raceProcessorId, or referenceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodmoveRaceProcessorEnablerBehind
Description

Reorders race processor enablers for a race processor by moving the specified race processor enabler behind a reference race processor enabler.

Parametersosid.id.IdraceProcessorEnablerIdthe Id of a RaceProcessorEnabler
osid.id.IdraceProcessorIdthe Id of a RaceProcessor
osid.id.IdreferenceIdthe reference race processor enabler Id
ErrorsNOT_FOUND praceProcessorEnablerId, raceProcessorId, or referenceId not found or, raceProcessorEnablerId or referenceId not related to processorId
NULL_ARGUMENT raceProcessorEnablerId, raceProcessorId, or referenceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodorderRaceProcessorEnablers
Description

Reorders a set of race processor enablers for a race processor.

Parametersosid.id.Id[]raceProcessorEnablerIdsthe Ids for a set of RaceProcessorEnablers
osid.id.IdraceProcessorIdthe Id of a RaceProcessor
ErrorsNOT_FOUND raceProcessorId not found or, a raceProcessorEnablerId not related to raceProcessorId
NULL_ARGUMENT raceProcessorEnablerIds or raceProcessorId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.