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

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

MethodcanAssignVotes
Description

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

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

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

Parametersosid.id.IdpollsIdthe Id of the Polls
osid.id.IdvoteIdthe Id of the Vote
Returnosid.id.IdListlist of assignable polls Ids
ErrorsNULL_ARGUMENT pollsId or voteId is null
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodassignVoteToPolls
Description

Adds an existing Vote to a Polls.

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

Removes a Vote from a Polls.

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