org.osid.voting.batch

Interface VotingBatchProxyManager

All Superinterfaces:

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

public interface VotingBatchProxyManager
extends OsidProxyManager, VotingBatchProfile

The voting batch proxy manager provides access to voting batch sessions and provides interoperability tests for various aspects of this service. Methods in this manager support the passing of a Proxy object. The sessions included in this manager are:

• VotingBatchSession: a session to vote in bulk
• CandidateBatchAdminSession: a session to manage candidates in bulk
• RaceBatchAdminSession: a session to manage races in bulk
• BallotBatchAdminSession: a session to manage ballotd in bulk
• PollsBatchAdminSession: a session to create, modify and delete Polls in bulk

Method Summary

Methods

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

Methods inherited from interface org.osid.OsidProxyManager

changeBranch, initialize, rollbackService

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

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(Proxy proxy)
                                         throws OperationFailedException

Gets the OsidSession associated with the bulk voting service.

Parameters:

proxy - a proxy

Returns:

a VotingBatchAdminSession

Throws:

NullArgumentException - proxy is null

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,
                                             Proxy proxy)
                                               throws NotFoundException,
                                                      OperationFailedException

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

Parameters:

pollsId - the Id of the Polls

proxy - a proxy

Returns:

a VotingBatchAdminSession

Throws:

NotFoundException - no Polls found by the given Id

NullArgumentException - pollsId or proxy 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(Proxy proxy)
                                                         throws OperationFailedException

Gets the OsidSession associated with the bulk candidate administration service.

Parameters:

proxy - a proxy

Returns:

a CandidateBatchAdminSession

Throws:

NullArgumentException - proxy is null

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,
                                                               Proxy proxy)
                                                                 throws NotFoundException,
                                                                        OperationFailedException

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

Parameters:

pollsId - the Id of the Polls

proxy - a proxy

Returns:

a CandidateBatchAdminSession

Throws:

NotFoundException - no Polls found by the given Id

NullArgumentException - pollsId or proxy 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(Proxy proxy)
                                               throws OperationFailedException

Gets the OsidSession associated with the bulk ballot administration service.

Parameters:

proxy - a proxy

Returns:

a BallotBatchAdminSession

Throws:

NullArgumentException - proxy is null

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,
                                                     Proxy proxy)
                                                       throws NotFoundException,
                                                              OperationFailedException

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

Parameters:

pollsId - the Id of the Polls

proxy - a proxy

Returns:

a RaceBatchAdminSession

Throws:

NotFoundException - no Polls found by the given Id

NullArgumentException - pollsId or proxy 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(Proxy proxy)
                                                   throws OperationFailedException

Gets the OsidSession associated with the bulk ballot administration service.

Parameters:

proxy - a proxy

Returns:

a BallotBatchAdminSession

Throws:

NullArgumentException - proxy is null

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,
                                                         Proxy proxy)
                                                           throws NotFoundException,
                                                                  OperationFailedException

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

Parameters:

pollsId - the Id of the Polls

proxy - a proxy

Returns:

a BallotBatchAdminSession

Throws:

NotFoundException - no Polls found by the given Id

NullArgumentException - pollsId or proxy 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(Proxy proxy)
                                                 throws OperationFailedException

Gets the OsidSession associated with the bulk polls administration service.

Parameters:

proxy - a proxy

Returns:

a PollsBatchAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPollsBatchAdmin() is false

Compliance:

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