OSID Logo
OSID Specifications
voting package
Version 3.1.0
Interfaceosid.voting.RacePollsAssignmentSession
Implementsosid.OsidSession
Used Byosid.voting.VotingManager
osid.voting.VotingProxyManager
Description

This session provides methods to re-assign Races to Polls objects A Race may appear in multiple Polls objects and removing the last reference to a Race is the equivalent of deleting it. Each Polls may have its own authorizations governing who is allowed to operate on it.

Moving or adding a reference of a Race to another Polls is not a copy operation (eg: does not change its Id).

MethodcanAssignRaces
Description

Tests if this user can alter race/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 assignment operations to unauthorized users.

Returnboolean false if mapping is not authorized, true otherwise
Compliancemandatory This method must be implemented.
MethodcanAssignRacesToPolls
Description

Tests if this user can alter race/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 assignment operations to unauthorized users.

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

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

Parametersosid.id.IdpollsId the Id of the Polls
Returnosid.id.IdList list of assignable polls Ids
ErrorsNULL_ARGUMENT pollsId is null
OPERATION_FAILED unable to complete request
Compliancemandatory This method must be implemented.
MethodgetAssignablePollsIdsForRace
Description

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

Parametersosid.id.IdpollsId the Id of the Polls
osid.id.IdraceId the Id of the Race
Returnosid.id.IdList list of assignable polls Ids
ErrorsNULL_ARGUMENT polls or raceId is null
OPERATION_FAILED unable to complete request
Compliancemandatory This method must be implemented.
MethodassignRaceToPolls
Description

Adds an existing Race to a Polls.

Parametersosid.id.IdraceId the Id of the Race
osid.id.IdpollsId the Id of the Polls
ErrorsALREADY_EXISTS raceId is already assigned to pollsId
NOT_FOUND raceId or pollsId not found
NULL_ARGUMENT raceId or pollsId is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethodunassignRaceFromPolls
Description

Removes a Race from a Polls.

Parametersosid.id.IdraceId the Id of the Race
osid.id.IdpollsId the Id of the Polls
ErrorsNOT_FOUND raceId or pollsId not found or raceId not assigned to pollsId
NULL_ARGUMENT raceId or pollsId is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethodreassignRaceToPolls
Description

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

Parametersosid.id.IdraceId the Id of the Race
osid.id.IdfromPollsId the Id of the current Polls
osid.id.IdtoPollsId the Id of the destination Polls
ErrorsALREADY_EXISTS raceId already assigned to toPollsId
NOT_FOUND raceId, fromPollsId, or toPollsId not found or raceId not mapped to fromPollsId
NULL_ARGUMENT raceId, fromPollsId, or toPollsId is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.