Interface VotingBatchManager

All Superinterfaces:

AutoCloseable, Closeable, OsidManager, 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

Modifier and Type	Method	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 Closeable

close

Methods inherited from interface OsidManager

close

Modifier and Type	Method	Description
void	close()	Close this manager.

Methods inherited from interface OsidManager

changeBranch, initialize, rollbackService

Modifier and Type	Method	Description
void	changeBranch(Id branchId)	Changes the service branch.
void	initialize(OsidRuntimeManager runtime)	Initializes this manager.
JournalEntry	rollbackService(Date rollbackTime)	Rolls back this service to a point in time.

Methods inherited from interface OsidProfile

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

Modifier and Type	Method	Description
Branch	getBranch()	Gets this service branch.
Id	getBranchId()	Gets the Branch Id representing this service branch.
DisplayText	getDescription()	Gets a description of this service implementation.
DisplayText	getDisplayName()	Gets a display name for this service implementation.
Id	getId()	Gets an identifier for this service implementation.
LocaleList	getLocales()	Gets the locales supported in this service.
TypeList	getProxyRecordTypes()	Gets the proxy record Types supported in this service.
DateTime	getReleaseDate()	Gets the date this service implementation was released.
Version	getVersion()	Gets the version of this service implementation.
boolean	supportsJournalBranching()	Test for support of a journal branching service.
boolean	supportsJournalRollback()	Test for support of a journaling rollback service.
boolean	supportsOSIDVersion(Version version)	Test for support of an OSID specification version.
boolean	supportsProxyRecordType(Type proxyRecordType)	Test for support of a proxy type.

Methods inherited from interface Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Modifier and Type	Method	Description
AssetList	getBranding()	Gets a branding, such as an image or logo, expressed using the Asset interface.
IdList	getBrandingIds()	Gets the branding asset Ids .
DisplayText	getLicense()	Gets the terms of usage.
Resource	getProvider()	Gets the Resource representing the provider.
Id	getProviderId()	Gets the Id of the provider.

Methods inherited from interface VotingBatchProfile

supportsBallotBatchAdmin, supportsCandidateBatchAdmin, supportsPollsBatchAdmin, supportsRaceBatchAdmin, supportsVisibleFederation, supportsVotingBatchAdmin

Modifier and Type	Method	Description
boolean	supportsBallotBatchAdmin()	Tests if bulk administration of ballots is available.
boolean	supportsCandidateBatchAdmin()	Tests if bulk administration of candidates is available.
boolean	supportsPollsBatchAdmin()	Tests if bulk administration of polls is available.
boolean	supportsRaceBatchAdmin()	Tests if bulk administration of races is available.
boolean	supportsVisibleFederation()	Tests if federation is visible.
boolean	supportsVotingBatchAdmin()	Tests if bulk voting is available.

Method Details

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 {@code supportsVotingBatchAdmin()} is {@code 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 {@code supportsVotingBatchAdmin()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsCandidateBatchAdmin()} is {@code 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 {@code supportsCandidateBatchAdmin()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsRaceBatchAdmin()} is {@code 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 {@code supportsRaceBatchAdmin()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsBallotBatchAdmin()} is {@code 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 {@code supportsBallotBatchAdmin()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsPollsBatchAdmin()} is {@code true} .