OSID Logo
OSID Specifications
voting batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.voting.batch.VotingBatchManager
Implementsosid.OsidManager
osid.voting.batch.VotingBatchProfile
Description

The voting batch manager provides access to voting batch sessions and provides interoperability tests for various aspects of this service. The sessions included in this manager are:

  • VotingBatchSession: a session to vote in bulk
  • CandidateBatchAdminSession: a session to create, modify and delete Candidates in bulk
  • RaceBatchAdminSession: a session to create, modify and delete Races in bulk
  • BallotBatchAdminSession: a session to create, modify and delete Ballots in bulk
  • PollsBatchAdminSession: a session to create, modify and delete Polls in bulk
MethodgetVotingBatchSession
Description

Gets the OsidSession associated with the bulk voting service.

Returnosid.voting.batch.VotingBatchSessiona VotingBatchAdminSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsVotingBatchAdmin() is false
ComplianceoptionalThis method must be implemented if supportsVotingBatchAdmin() is true.
MethodgetVoteBatchSessionForPolls
Description

Gets the OsidSession associated with the bulk voting service for the given polls.

Parametersosid.id.IdpollsIdthe Id of the Polls
Returnosid.voting.batch.VotingBatchSessiona VotingBatchAdminSession
ErrorsNOT_FOUNDno Polls found by the given Id
NULL_ARGUMENT pollsId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsVotingBatchAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsVotingBatchAdmin() and supportsVisibleFederation() are true
MethodgetCandidateBatchAdminSession
Description

Gets the OsidSession associated with the bulk candidate administration service.

Returnosid.voting.batch.CandidateBatchAdminSessiona CandidateBatchAdminSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsCandidateBatchAdmin() is false
ComplianceoptionalThis method must be implemented if supportsCandidateBatchAdmin() is true.
MethodgetCandidateBatchAdminSessionForPolls
Description

Gets the OsidSession associated with the bulk candidate administration service for the given polls.

Parametersosid.id.IdpollsIdthe Id of the Polls
Returnosid.voting.batch.CandidateBatchAdminSessiona CandidateBatchAdminSession
ErrorsNOT_FOUNDno Polls found by the given Id
NULL_ARGUMENT pollsId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsCandidateBatchAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsCandidateBatchAdmin() and supportsVisibleFederation() are true
MethodgetRaceBatchAdminSession
Description

Gets the OsidSession associated with the bulk race administration service.

Returnosid.voting.batch.RaceBatchAdminSessiona RaceBatchAdminSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsRaceBatchAdmin() is false
ComplianceoptionalThis method must be implemented if supportsRaceBatchAdmin() is true.
MethodgetRaceBatchAdminSessionForPolls
Description

Gets the OsidSession associated with the bulk race administration service for the given polls.

Parametersosid.id.IdpollsIdthe Id of the Polls
Returnosid.voting.batch.RaceBatchAdminSessiona RaceBatchAdminSession
ErrorsNOT_FOUNDno Polls found by the given Id
NULL_ARGUMENT pollsId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsRaceBatchAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsRaceBatchAdmin() and supportsVisibleFederation() are true
MethodgetBallotBatchAdminSession
Description

Gets the OsidSession associated with the bulk ballot administration service.

Returnosid.voting.batch.BallotBatchAdminSessiona BallotBatchAdminSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsBallotBatchAdmin() is false
ComplianceoptionalThis method must be implemented if supportsBallotBatchAdmin() is true.
MethodgetBallotBatchAdminSessionForPolls
Description

Gets the OsidSession associated with the bulk ballot administration service for the given polls.

Parametersosid.id.IdpollsIdthe Id of the Polls
Returnosid.voting.batch.BallotBatchAdminSessiona BallotBatchAdminSession
ErrorsNOT_FOUNDno Polls found by the given Id
NULL_ARGUMENT pollsId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsBallotBatchAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsBallotBatchAdmin() and supportsVisibleFederation() are true
MethodgetPollsBatchAdminSession
Description

Gets the OsidSession associated with the bulk polls administration service.

Returnosid.voting.batch.PollsBatchAdminSessiona PollsBatchAdminSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPollsBatchAdmin() is false
ComplianceoptionalThis method must be implemented if supportsPollsBatchAdmin() is true.