org.osid.voting.batch

Interface VotingBatchManager

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidManager, OsidProfile, Sourceable, VotingBatchProfile

public interface VotingBatchManager
extends OsidManager, VotingBatchProfile

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

Method Summary

Methods

Modifier and Type	Method and Description
BallotBatchAdminSession	getBallotBatchAdminSession() Gets the OsidSession associated with the bulk ballot administration service.
BallotBatchAdminSession	getBallotBatchAdminSessionForPolls(Id pollsId) Gets the OsidSession associated with the bulk ballot administration service for the given polls.
CandidateBatchAdminSession	getCandidateBatchAdminSession() Gets the OsidSession associated with the bulk candidate administration service.
CandidateBatchAdminSession	getCandidateBatchAdminSessionForPolls(Id pollsId) Gets the OsidSession associated with the bulk candidate administration service for the given polls.
PollsBatchAdminSession	getPollsBatchAdminSession() Gets the OsidSession associated with the bulk polls administration service.
RaceBatchAdminSession	getRaceBatchAdminSession() Gets the OsidSession associated with the bulk race administration service.
RaceBatchAdminSession	getRaceBatchAdminSessionForPolls(Id pollsId) Gets the OsidSession associated with the bulk race administration service for the given polls.
VotingBatchSession	getVoteBatchSessionForPolls(Id pollsId) Gets the OsidSession associated with the bulk voting service for the given polls.
VotingBatchSession	getVotingBatchSession() Gets the OsidSession associated with the bulk voting service.

Methods inherited from interface org.osid.OsidManager

changeBranch, initialize, rollbackService

Methods inherited from interface org.osid.binding.java.OsidManager

close

Methods inherited from interface java.io.Closeable

close

Methods inherited from interface org.osid.voting.batch.VotingBatchProfile

supportsBallotBatchAdmin, supportsCandidateBatchAdmin, supportsPollsBatchAdmin, supportsRaceBatchAdmin, supportsVisibleFederation, supportsVotingBatchAdmin

Methods inherited from interface org.osid.OsidProfile

getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordType

Methods inherited from interface org.osid.Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Method Detail

getVotingBatchSession

VotingBatchSession getVotingBatchSession()
                                         throws OperationFailedException

Gets the OsidSession associated with the bulk voting service.

Returns:

a VotingBatchAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsVotingBatchAdmin() is false

Compliance:

optional - This method must be implemented if supportsVotingBatchAdmin() is true.

getVoteBatchSessionForPolls

VotingBatchSession getVoteBatchSessionForPolls(Id pollsId)
                                               throws NotFoundException,
                                                      OperationFailedException

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

Parameters:

pollsId - the Id of the Polls

Returns:

a VotingBatchAdminSession

Throws:

NotFoundException - no Polls found by the given Id

NullArgumentException - pollsId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsVotingBatchAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsVotingBatchAdmin() and supportsVisibleFederation() are true

getCandidateBatchAdminSession

CandidateBatchAdminSession getCandidateBatchAdminSession()
                                                         throws OperationFailedException

Gets the OsidSession associated with the bulk candidate administration service.

Returns:

a CandidateBatchAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsCandidateBatchAdmin() is false

Compliance:

optional - This method must be implemented if supportsCandidateBatchAdmin() is true.

getCandidateBatchAdminSessionForPolls

CandidateBatchAdminSession getCandidateBatchAdminSessionForPolls(Id pollsId)
                                                                 throws NotFoundException,
                                                                        OperationFailedException

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

Parameters:

pollsId - the Id of the Polls

Returns:

a CandidateBatchAdminSession

Throws:

NotFoundException - no Polls found by the given Id

NullArgumentException - pollsId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCandidateBatchAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsCandidateBatchAdmin() and supportsVisibleFederation() are true

getRaceBatchAdminSession

RaceBatchAdminSession getRaceBatchAdminSession()
                                               throws OperationFailedException

Gets the OsidSession associated with the bulk race administration service.

Returns:

a RaceBatchAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsRaceBatchAdmin() is false

Compliance:

optional - This method must be implemented if supportsRaceBatchAdmin() is true.

getRaceBatchAdminSessionForPolls

RaceBatchAdminSession getRaceBatchAdminSessionForPolls(Id pollsId)
                                                       throws NotFoundException,
                                                              OperationFailedException

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

Parameters:

pollsId - the Id of the Polls

Returns:

a RaceBatchAdminSession

Throws:

NotFoundException - no Polls found by the given Id

NullArgumentException - pollsId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRaceBatchAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsRaceBatchAdmin() and supportsVisibleFederation() are true

getBallotBatchAdminSession

BallotBatchAdminSession getBallotBatchAdminSession()
                                                   throws OperationFailedException

Gets the OsidSession associated with the bulk ballot administration service.

Returns:

a BallotBatchAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsBallotBatchAdmin() is false

Compliance:

optional - This method must be implemented if supportsBallotBatchAdmin() is true.

getBallotBatchAdminSessionForPolls

BallotBatchAdminSession getBallotBatchAdminSessionForPolls(Id pollsId)
                                                           throws NotFoundException,
                                                                  OperationFailedException

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

Parameters:

pollsId - the Id of the Polls

Returns:

a BallotBatchAdminSession

Throws:

NotFoundException - no Polls found by the given Id

NullArgumentException - pollsId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsBallotBatchAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsBallotBatchAdmin() and supportsVisibleFederation() are true

getPollsBatchAdminSession

PollsBatchAdminSession getPollsBatchAdminSession()
                                                 throws OperationFailedException

Gets the OsidSession associated with the bulk polls administration service.

Returns:

a PollsBatchAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsPollsBatchAdmin() is false

Compliance:

optional - This method must be implemented if supportsPollsBatchAdmin() is true.