Interface | osid.voting.batch.VotingBatchManager | ||
---|---|---|---|
Implements | osid.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:
| ||
Method | getVotingBatchSession | ||
Description |
Gets the | ||
Return | osid.voting.batch.VotingBatchSession | a VotingBatchAdminSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsVotingBatchAdmin() is false | ||
Compliance | optional | This method must be implemented if supportsVotingBatchAdmin()
is true. | |
Method | getVoteBatchSessionForPolls | ||
Description |
Gets the | ||
Parameters | osid.id.Id | pollsId | the Id of the Polls |
Return | osid.voting.batch.VotingBatchSession | a VotingBatchAdminSession | |
Errors | NOT_FOUND | no Polls found by the given Id | |
NULL_ARGUMENT | pollsId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsVotingBatchAdmin() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsVotingBatchAdmin()
and supportsVisibleFederation() are true | |
Method | getCandidateBatchAdminSession | ||
Description |
Gets the | ||
Return | osid.voting.batch.CandidateBatchAdminSession | a CandidateBatchAdminSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsCandidateBatchAdmin() is false | ||
Compliance | optional | This method must be implemented if supportsCandidateBatchAdmin()
is true. | |
Method | getCandidateBatchAdminSessionForPolls | ||
Description |
Gets the | ||
Parameters | osid.id.Id | pollsId | the Id of the Polls |
Return | osid.voting.batch.CandidateBatchAdminSession | a CandidateBatchAdminSession | |
Errors | NOT_FOUND | no Polls found by the given Id | |
NULL_ARGUMENT | pollsId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsCandidateBatchAdmin() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsCandidateBatchAdmin()
and supportsVisibleFederation() are true | |
Method | getRaceBatchAdminSession | ||
Description |
Gets the | ||
Return | osid.voting.batch.RaceBatchAdminSession | a RaceBatchAdminSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsRaceBatchAdmin() is false | ||
Compliance | optional | This method must be implemented if supportsRaceBatchAdmin()
is true. | |
Method | getRaceBatchAdminSessionForPolls | ||
Description |
Gets the | ||
Parameters | osid.id.Id | pollsId | the Id of the Polls |
Return | osid.voting.batch.RaceBatchAdminSession | a RaceBatchAdminSession | |
Errors | NOT_FOUND | no Polls found by the given Id | |
NULL_ARGUMENT | pollsId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsRaceBatchAdmin() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsRaceBatchAdmin()
and supportsVisibleFederation() are true | |
Method | getBallotBatchAdminSession | ||
Description |
Gets the | ||
Return | osid.voting.batch.BallotBatchAdminSession | a BallotBatchAdminSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsBallotBatchAdmin() is false | ||
Compliance | optional | This method must be implemented if supportsBallotBatchAdmin()
is true. | |
Method | getBallotBatchAdminSessionForPolls | ||
Description |
Gets the | ||
Parameters | osid.id.Id | pollsId | the Id of the Polls |
Return | osid.voting.batch.BallotBatchAdminSession | a BallotBatchAdminSession | |
Errors | NOT_FOUND | no Polls found by the given Id | |
NULL_ARGUMENT | pollsId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsBallotBatchAdmin() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsBallotBatchAdmin()
and supportsVisibleFederation() are true | |
Method | getPollsBatchAdminSession | ||
Description |
Gets the | ||
Return | osid.voting.batch.PollsBatchAdminSession | a PollsBatchAdminSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsPollsBatchAdmin() is false | ||
Compliance | optional | This method must be implemented if supportsPollsBatchAdmin()
is true. |