OSID Logo
OSID Specifications
voting package
Version 3.0.0
Release Candidate Preview
Interfaceosid.voting.RacePollsAssignmentSession
Implementsosid.OsidSession
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
CompliancemandatoryThis 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.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 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.
MethodgetAssignablePollsIdsForRace
Description

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

Parametersosid.id.IdpollsIdthe Id of the Polls
osid.id.IdraceIdthe Id of the Race
Returnosid.id.IdListlist of assignable polls Ids
ErrorsNULL_ARGUMENT polls or raceId is null
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodassignRaceToPolls
Description

Adds an existing Race to a Polls.

Parametersosid.id.IdraceIdthe Id of the Race
osid.id.IdpollsIdthe 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_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodunassignRaceFromPolls
Description

Removes a Race from a Polls.

Parametersosid.id.IdraceIdthe Id of the Race
osid.id.IdpollsIdthe 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_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.