OSID Logo
OSID Specifications
voting rules package
Version 3.0.0
Interfaceosid.voting.rules.RaceConstrainerEnablerPollsAssignmentSession
Implementsosid.OsidSession
Used Byosid.voting.rules.VotingRulesManager
osid.voting.rules.VotingRulesProxyManager
Description

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

MethodcanAssignRaceConstrainerEnablers
Description

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.

Returnbooleanfalse if mapping is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodcanAssignRaceConstrainerEnablersToPolls
Description

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.

Parametersosid.id.IdpollsIdthe Id of the Polls
Returnbooleanfalse if mapping is not authorized, true otherwise
ErrorsNULL_ARGUMENTpollsId 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 constrainer enabler can be assigned.

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

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

Parametersosid.id.IdpollsIdthe Id of the Polls
osid.id.IdraceConstrainerEnablerIdthe Id of the RaceConstrainerEnabler
Returnosid.id.IdListlist of assignable polls Ids
ErrorsNULL_ARGUMENTpollsId or raceConstrainerEnablerId is null
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodassignRaceConstrainerEnablerToPolls
Description

Adds an existing RaceConstrainerEnabler to a Polls .

Parametersosid.id.IdraceConstrainerEnablerIdthe Id of the RaceConstrainerEnabler
osid.id.IdpollsIdthe Id of the Polls
ErrorsALREADY_EXISTSraceConstrainerEnablerId is already assigned to pollsId
NOT_FOUNDraceConstrainerEnablerId or pollsId not found
NULL_ARGUMENTraceConstrainerEnablerId or pollsId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodunassignRaceConstrainerEnablerFromPolls
Description

Removes a RaceConstrainerEnabler from a Polls .

Parametersosid.id.IdraceConstrainerEnablerIdthe Id of the RaceConstrainerEnabler
osid.id.IdpollsIdthe Id of the Polls
ErrorsNOT_FOUNDraceConstrainerEnablerId or pollsId not found or raceConstrainerEnablerId not assigned to pollsId
NULL_ARGUMENTraceConstrainerEnablerId or pollsId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodreassignRaceConstrainerEnablerToPolls
Description

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

Parametersosid.id.IdraceConstrainerEnablerIdthe Id of the RaceConstrainerEnabler
osid.id.IdfromPollsIdthe Id of the current Polls
osid.id.IdtoPollsIdthe Id of the destination Polls
ErrorsALREADY_EXISTSraceConstrainerEnablerId already assigned to toPollsId
NOT_FOUNDraceConstrainerEnablerId, fromPollsId , or toPollsId not found or raceConstrainerEnablerId not mapped to fromPollsId
NULL_ARGUMENTraceConstrainerEnablerId, fromPollsId , or toPollsId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.