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

This session provides methods to re-assign Ballots to Polls. A Ballot may map to multiple Polls objects and removing the last reference to a Ballot 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 Ballot to another Polls is not a copy operation (eg: does not change its Id ).

MethodcanAssignBallots
Description

Tests if this user can alter ballot/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.
MethodcanAssignBallotsToPolls
Description

Tests if this user can alter ballot/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 ballot 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.
MethodgetAssignablePollsIdsForBallot
Description

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

Parametersosid.id.IdpollsIdthe Id of the Polls
osid.id.IdballotIdthe Id of the Ballot
Returnosid.id.IdListlist of assignable polls Ids
ErrorsNULL_ARGUMENT pollsId or ballotId is null
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodassignBallotToPolls
Description

Adds an existing Ballot to a Polls.

Parametersosid.id.IdballotIdthe Id of the Ballot
osid.id.IdpollsIdthe Id of the Polls
ErrorsALREADY_EXISTS ballotId is already assigned to pollsId
NOT_FOUND ballotId or pollsId not found
NULL_ARGUMENT ballotId or pollsId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodunassignBallotFromPolls
Description

Removes a Ballot from a Polls.

Parametersosid.id.IdballotIdthe Id of the Ballot
osid.id.IdpollsIdthe Id of the Polls
ErrorsNOT_FOUND ballotId or pollsId not found or ballotId not assigned to pollsId
NULL_ARGUMENT ballotId or pollsId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.