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

This session provides methods to apply RaceConstrainerEnablers to RaceConstrainers. a RaceConstrainer with multiple RaceConstrainerEnablers means any positive rule evaluation across the enablers result in an effective RaceConstrainer.

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.
MethodcanAssignRaceConstrainerEnablers
Description

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

Adds an existing RaceConstrainerEnabler to a RaceConstrainer.

Parametersosid.id.IdraceConstrainerEnablerIdthe Id of the RaceConstrainerEnabler
osid.id.IdraceConstrainerIdthe Id of the RaceConstrainer
ErrorsALREADY_EXISTS raceConstrainerEnablerId is already applied to raceConstrainerId
NOT_FOUND raceConstrainerEnablerId or raceConstrainerId not found
NULL_ARGUMENT raceConstrainerEnablerId or raceConstrainerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodunassignRaceConstrainerEnablerFromRaceConstrainer
Description

Removes a RaceConstrainerEnabler from a RaceConstrainer.

Parametersosid.id.IdraceConstrainerEnablerIdthe Id of the RaceConstrainerEnabler
osid.id.IdraceConstrainerIdthe Id of the RaceConstrainer
ErrorsNOT_FOUND raceConstrainerEnablerId or raceConstrainerId not found or raceConstrainerEnablerId not applied to raceConstrainerId
NULL_ARGUMENT raceConstrainerEnablerId or raceConstrainerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanSequenceRaceConstrainerEnablers
Description

Tests if this user can order RaceConstrainerEnablers. 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 RaceConstrainerEnabler ordering is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodmoveRaceConstrainerEnablerAhead
Description

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

Parametersosid.id.IdraceConstrainerEnablerIdthe Id of a RaceConstrainerEnabler
osid.id.IdraceConstrainerIdthe Id of a RaceConstrainer
osid.id.IdreferenceIdthe reference race constrainer enabler Id
ErrorsNOT_FOUND raceConstrainerEnablerId, raceConstrainerId, or referenceId not found or, raceConstrainerEnablerId or referenceId not related to raceConstrainerId
NULL_ARGUMENT raceConstrainerEnablerId, raceConstrainerId, or referenceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodmoveRaceConstrainerEnablerBehind
Description

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

Parametersosid.id.IdraceConstrainerEnablerIdthe Id of a RaceConstrainerEnabler
osid.id.IdraceConstrainerIdthe Id of a RaceConstrainer
osid.id.IdreferenceIdthe reference race constrainer enabler Id
ErrorsNOT_FOUND raceConstrainerEnablerId, raceConstrainerId, or referenceId not found or, raceConstrainerEnablerId or referenceId not related to raceConstrainerId
NULL_ARGUMENT raceConstrainerEnablerId, raceConstrainerId, or referenceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodorderRaceConstrainerEnablers
Description

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

Parametersosid.id.Id[]raceConstrainerEnablerIdsthe Ids for a set of RaceConstrainerEnablers
osid.id.IdraceConstrainerIdthe Id of a RaceConstrainer
ErrorsNOT_FOUND raceConstrainerId not found or, a raceConstrainerEnablerId not related to raceConstrainerId
NULL_ARGUMENT raceConstrainerEnablerIds or raceConstrainerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.