org.osid.voting

Interface VotingManager

All Superinterfaces:

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

public interface VotingManager
extends OsidManager, VotingProfile

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

• VotingSession: a session to vote
• VotingResultsSession: a session to examine voting results
• VoterAllocationLookupSession: a session to look up voter allocations
• VoterAllocationAdminSession: a session to manage voter allocations
• VoteLookupSession: a session to retrieve votes
• VoteQuerySession: a session to query for votes
• VoteSearchSession: a session to search for votes
• VoteAdminSession: a session to create and delete votes
• VoteNotificationSession: a session to receive notifications pertaining to votechanges
• VotePollsSession: a session to look up vote to polls mappings
• VotePollsAssignmentSession: a session to manage vote to polls mappings
• VoteSmartPollsSession: a session to manage smart vote pollss

• CandidateLookupSession: a session to retrieve candidates
• CandidateQuerySession: a session to query candidates
• CandidateSearchSession: a session to search for candidates
• CandidateAdminSession: a session to create and delete candidates
• CandidateNotificationSession: a session to receive notifications pertaining to candidate changes
• CandidatePollsSession: a session to look up candidate to polls mappings
• CandidatePollsAssignmentSession: a session to manage candidate to polls mappings
• CandidateSmartPollsSession: a session to manage smart candidate polls

• RaceLookupSession: a session to retrieve races
• RaceQuerySession: a session to query for races
• RaceSearchSession: a session to search for races
• RaceAdminSession: a session to create and delete races
• RaceNotificationSession: a session to receive notifications pertaining to races changes
• RacePollsSession: a session to look up races to polls mappings
• RacePollsAssignmentSession: a session to manage race to polls mappings
• RaceSmartPollsSession: a session to manage smart race polls

• BallotLookupSession: a session to retrieve ballots
• BallotQuerySession: a session to query for ballots
• BallotSearchSession: a session to search for ballots
• BallotAdminSession: a session to create and delete ballots
• BallotNotificationSession: a session to receive notifications pertaining to ballots changes
• BallotPollsSession: a session to look up ballots to polls mappings
• BallotPollsAssignmentSession: a session to manage ballot to polls mappings
• BallotSmartPollsSession: a session to manage smart ballot polls

• PollsLookupSession: a session to retrieve polls
• PollsQuerySession: a session to query polls
• PollsSearchSession: a session to search for pollss
• PollsAdminSession: a session to create, update and delete polls
• PollsNotificationSession: a session to receive notifications pertaining to changes in polls
• PollsHierarchySession: a session to traverse polls hierarchies
• PollsHierarchyDesignSession: a session to manage polls hierarchies

Method Summary

Methods

Modifier and Type	Method and Description
BallotAdminSession	getBallotAdminSession() Gets the OsidSession associated with the ballot administration service.
BallotAdminSession	getBallotAdminSessionForPolls(Id pollsId) Gets the OsidSession associated with the ballot administration service for the given polls.
BallotLookupSession	getBallotLookupSession() Gets the OsidSession associated with the ballot lookup service.
BallotLookupSession	getBallotLookupSessionForPolls(Id pollsId) Gets the OsidSession associated with the ballot lookup service for the given polls.
BallotNotificationSession	getBallotNotificationSession(BallotReceiver ballotReceiver) Gets the OsidSession associated with the ballot notification service.
BallotNotificationSession	getBallotNotificationSessionForPolls(BallotReceiver ballotReceiver, Id pollsId) Gets the OsidSession associated with the ballot notification service for the given polls.
BallotPollsAssignmentSession	getBallotPollsAssignmentSession() Gets the session for assigning ballot to polls mappings.
BallotPollsSession	getBallotPollsSession() Gets the session for retrieving ballot to polls mappings.
BallotQuerySession	getBallotQuerySession() Gets the OsidSession associated with the ballot query service.
BallotQuerySession	getBallotQuerySessionForPolls(Id pollsId) Gets the OsidSession associated with the ballot query service for the given polls.
BallotSearchSession	getBallotSearchSession() Gets the OsidSession associated with the ballot search service.
BallotSearchSession	getBallotSearchSessionForPolls(Id pollsId) Gets the OsidSession associated with the ballot search service for the given polls.
BallotSmartPollsSession	getBallotSmartPollsSession(Id pollsId) Gets the session for managing dynamic ballot polls.
CandidateAdminSession	getCandidateAdminSession() Gets a candidate administration session for creating, updating and deleting candidates.
CandidateAdminSession	getCandidateAdminSessionForPolls(Id pollsId) Gets a candidate administration session for the given polls.
CandidateLookupSession	getCandidateLookupSession() Gets the OsidSession associated with the candidate lookup service.
CandidateLookupSession	getCandidateLookupSessionForPolls(Id pollsId) Gets the OsidSession associated with the candidate lookup service for the given polls.
CandidateNotificationSession	getCandidateNotificationSession(CandidateReceiver candidateReceiver) Gets the notification session for notifications pertaining to candidate changes.
CandidateNotificationSession	getCandidateNotificationSessionForPolls(CandidateReceiver candidateReceiver, Id pollsId) Gets the candidate notification session for the given polls.
CandidatePollsAssignmentSession	getCandidatePollsAssignmentSession() Gets the session for assigning candidate to polls mappings.
CandidatePollsSession	getCandidatePollsSession() Gets the session for retrieving candidate to polls mappings.
CandidateQuerySession	getCandidateQuerySession() Gets a candidate query session.
CandidateQuerySession	getCandidateQuerySessionForPolls(Id pollsId) Gets a candidate query session for the given polls.
CandidateSearchSession	getCandidateSearchSession() Gets a candidate search session.
CandidateSearchSession	getCandidateSearchSessionForPolls(Id pollsId) Gets a candidate search session for the given polls.
CandidateSmartPollsSession	getCandidateSmartPollsSession(Id pollsId) Gets the session for managing dynamic candidate polls.
PollsAdminSession	getPollsAdminSession() Gets the polls administrative session for creating, updating and deleteing polls.
PollsHierarchyDesignSession	getPollsHierarchyDesignSession() Gets the polls hierarchy design session.
PollsHierarchySession	getPollsHierarchySession() Gets the polls hierarchy traversal session.
PollsLookupSession	getPollsLookupSession() Gets the polls lookup session.
PollsNotificationSession	getPollsNotificationSession(PollsReceiver pollsReceiver) Gets the notification session for subscripollsg to changes to a polls.
PollsQuerySession	getPollsQuerySession() Gets the polls query session.
PollsSearchSession	getPollsSearchSession() Gets the polls search session.
RaceAdminSession	getRaceAdminSession() Gets the OsidSession associated with the race administration service.
RaceAdminSession	getRaceAdminSessionForPolls(Id pollsId) Gets the OsidSession associated with the race administration service for the given polls.
RaceLookupSession	getRaceLookupSession() Gets the OsidSession associated with the race lookup service.
RaceLookupSession	getRaceLookupSessionForPolls(Id pollsId) Gets the OsidSession associated with the race lookup service for the given polls.
RaceNotificationSession	getRaceNotificationSession(RaceReceiver raceReceiver) Gets the OsidSession associated with the race notification service.
RaceNotificationSession	getRaceNotificationSessionForPolls(RaceReceiver raceReceiver, Id pollsId) Gets the OsidSession associated with the race notification service for the given polls.
RacePollsAssignmentSession	getRacePollsAssignmentSession() Gets the session for assigning race to polls mappings.
RacePollsSession	getRacePollsSession() Gets the session for retrieving race to polls mappings.
RaceQuerySession	getRaceQuerySession() Gets the OsidSession associated with the race query service.
RaceQuerySession	getRaceQuerySessionForPolls(Id pollsId) Gets the OsidSession associated with the race query service for the given polls.
RaceResultsSession	getRaceResultsSession() Gets the OsidSession associated with the race results service.
RaceResultsSession	getRaceResultsSessionForPolls(Id pollsId) Gets the OsidSession associated with the race results service for the given polls.
RaceSearchSession	getRaceSearchSession() Gets the OsidSession associated with the race search service.
VoteSearchSession	getRaceSearchSessionForPolls(Id pollsId) Gets the OsidSession associated with the race search service for the given polls.
RaceSmartPollsSession	getRaceSmartPollsSession(Id pollsId) Gets the session for managing dynamic race polls.
VoteLookupSession	getVoteLookupSession() Gets the OsidSession associated with the vote lookup service.
VoteLookupSession	getVoteLookupSessionForPolls(Id pollsId) Gets the OsidSession associated with the vote lookup service for the given polls.
VoteNotificationSession	getVoteNotificationSession(VoteReceiver voteReceiver) Gets the OsidSession associated with the vote notification service.
VoteNotificationSession	getVoteNotificationSessionForPolls(VoteReceiver voteReceiver, Id pollsId) Gets the OsidSession associated with the vote notification service for the given polls.
VotePollsAssignmentSession	getVotePollsAssignmentSession() Gets the session for assigning votes to polls mappings.
VotePollsSession	getVotePollsSession() Gets the session for retrieving vote to polls mappings.
VoteQuerySession	getVoteQuerySession() Gets the OsidSession associated with the vote query service.
VoteQuerySession	getVoteQuerySessionForPolls(Id pollsId) Gets the OsidSession associated with the vote query service for the given polls.
VoterAllocationAdminSession	getVoterAllocationAdminSession() Gets the OsidSession associated with the voter allocation administrative service.
VoterAllocationAdminSession	getVoterAllocationAdminSessionForPolls(Id pollsId) Gets the OsidSession associated with the voter allocation administrative service for the given polls.
VoterAllocationLookupSession	getVoterAllocationLookupSession() Gets the OsidSession associated with the voter allocation lookup service.
VoterAllocationLookupSession	getVoterAllocationLookupSessionForPolls(Id pollsId) Gets the OsidSession associated with the voter allocation lookup service for the given polls.
VoteSearchSession	getVoteSearchSession() Gets the OsidSession associated with the vote search service.
VoteSearchSession	getVoteSearchSessionForPolls(Id pollsId) Gets the OsidSession associated with the vote search service for the given polls.
VoteSmartPollsSession	getVoteSmartPollsSession(Id pollsId) Gets the session for managing dynamic vote polls.
VotingBatchManager	getVotingBatchManager() Gets a VotingBatchManager.
VotingRulesManager	getVotingRulesManager() Gets a VotingRulesManager.
VotingSession	getVotingSession() Gets the OsidSession associated with the voting service.
VotingSession	getVotingSessionForPolls(Id pollsId) Gets the OsidSession associated with the voting service for the given polls.

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.VotingProfile

getBallotRecordTypes, getBallotSearchRecordTypes, getCandidateRecordTypes, getCandidateSearchRecordTypes, getPollsRecordTypes, getPollsSearchRecordTypes, getRaceRecordTypes, getRaceSearchRecordTypes, getVoterAllocationRecordTypes, getVoteRecordTypes, getVoteSearchRecordTypes, getVotingResultsRecordTypes, supportsBallotAdmin, supportsBallotLookup, supportsBallotNotification, supportsBallotPolls, supportsBallotPollsAssignment, supportsBallotQuery, supportsBallotRecordType, supportsBallotSearch, supportsBallotSearchRecordType, supportsBallotSmartPolls, supportsCandidateAdmin, supportsCandidateLookup, supportsCandidateNotification, supportsCandidatePolls, supportsCandidatePollsAssignment, supportsCandidateQuery, supportsCandidateRecordType, supportsCandidateSearch, supportsCandidateSearchRecordType, supportsCandidateSmartPolls, supportsPollsAdmin, supportsPollsHierarchy, supportsPollsHierarchyDesign, supportsPollsLookup, supportsPollsNotification, supportsPollsQuery, supportsPollsRecordType, supportsPollsSearch, supportsPollsSearchRecordType, supportsRaceAdmin, supportsRaceLookup, supportsRaceNotification, supportsRacePolls, supportsRacePollsAssignment, supportsRaceQuery, supportsRaceRecordType, supportsRaceResults, supportsRaceSearch, supportsRaceSearchRecordType, supportsRaceSmartPolls, supportsVisibleFederation, supportsVoteLookup, supportsVoteNotification, supportsVotePolls, supportsVotePollsAssignment, supportsVoteQuery, supportsVoterAllocationRecordType, supportsVoteRecordType, supportsVoteSearch, supportsVoteSearchRecordType, supportsVoteSmartPolls, supportsVoting, supportsVotingAllocationAdmin, supportsVotingAllocationLookup, supportsVotingBatch, supportsVotingResultsRecordType, supportsVotingRules

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

getVotingSession

VotingSession getVotingSession()
                               throws OperationFailedException

Gets the OsidSession associated with the voting service.

Returns:

a VotingSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsVoting() is false

Compliance:

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

getVotingSessionForPolls

VotingSession getVotingSessionForPolls(Id pollsId)
                                       throws NotFoundException,
                                              OperationFailedException

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

Parameters:

pollsId - the Id of the Pools

Returns:

a VotingSession

Throws:

NotFoundException - no Polls found by the given Id

NullArgumentException - pollsId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsVoting() or supportsVisibleFederation() is false

Compliance:

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

getRaceResultsSession

RaceResultsSession getRaceResultsSession()
                                         throws OperationFailedException

Gets the OsidSession associated with the race results service.

Returns:

a RaceResultsSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsRaceResults() is false

Compliance:

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

getRaceResultsSessionForPolls

RaceResultsSession getRaceResultsSessionForPolls(Id pollsId)
                                                 throws NotFoundException,
                                                        OperationFailedException

Gets the OsidSession associated with the race results service for the given polls.

Parameters:

pollsId - the Id of the Pools

Returns:

a RaceResultsSession

Throws:

NotFoundException - no Polls found by the given Id

NullArgumentException - pollsId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRaceResults() or supportsVisibleFederation() is false

Compliance:

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

getVoterAllocationLookupSession

VoterAllocationLookupSession getVoterAllocationLookupSession()
                                                             throws OperationFailedException

Gets the OsidSession associated with the voter allocation lookup service.

Returns:

a VoterAllocationLookupSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsVoterAllocationLookup() is false

Compliance:

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

getVoterAllocationLookupSessionForPolls

VoterAllocationLookupSession getVoterAllocationLookupSessionForPolls(Id pollsId)
                                                                     throws NotFoundException,
                                                                            OperationFailedException

Gets the OsidSession associated with the voter allocation lookup service for the given polls.

Parameters:

pollsId - the Id of the Polls

Returns:

a VoterAllocationLookupSession

Throws:

NotFoundException - no Polls found by the given Id

NullArgumentException - pollsId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsVoterAllocationLookup() or supportsVisibleFederation() is false

Compliance:

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

getVoterAllocationAdminSession

VoterAllocationAdminSession getVoterAllocationAdminSession()
                                                           throws OperationFailedException

Gets the OsidSession associated with the voter allocation administrative service.

Returns:

a VoterAllocationAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsVoterAllocationAdmin() is false

Compliance:

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

getVoterAllocationAdminSessionForPolls

VoterAllocationAdminSession getVoterAllocationAdminSessionForPolls(Id pollsId)
                                                                   throws NotFoundException,
                                                                          OperationFailedException

Gets the OsidSession associated with the voter allocation administrative service for the given polls.

Parameters:

pollsId - the Id of the Polls

Returns:

a VoterAllocationAdminSession

Throws:

NotFoundException - no Polls found by the given Id

NullArgumentException - pollsId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsVoterAllocationAdmin() or supportsVisibleFederation() is false

Compliance:

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

getVoteLookupSession

VoteLookupSession getVoteLookupSession()
                                       throws OperationFailedException

Gets the OsidSession associated with the vote lookup service.

Returns:

a VoteLookupSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsVoteLookup() is false

Compliance:

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

getVoteLookupSessionForPolls

VoteLookupSession getVoteLookupSessionForPolls(Id pollsId)
                                               throws NotFoundException,
                                                      OperationFailedException

Gets the OsidSession associated with the vote lookup service for the given polls.

Parameters:

pollsId - the Id of the Polls

Returns:

a VoteLookupSession

Throws:

NotFoundException - no Polls found by the given Id

NullArgumentException - pollsId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsVoteLookup() or supportsVisibleFederation() is false

Compliance:

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

getVoteQuerySession

VoteQuerySession getVoteQuerySession()
                                     throws OperationFailedException

Gets the OsidSession associated with the vote query service.

Returns:

a VoteQuerySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsVoteQuery() is false

Compliance:

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

getVoteQuerySessionForPolls

VoteQuerySession getVoteQuerySessionForPolls(Id pollsId)
                                             throws NotFoundException,
                                                    OperationFailedException

Gets the OsidSession associated with the vote query service for the given polls.

Parameters:

pollsId - the Id of the Polls

Returns:

a VoteQuerySession

Throws:

NotFoundException - no Polls found by the given Id

NullArgumentException - pollsId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsVoteQuery() or supportsVisibleFederation() is false

Compliance:

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

getVoteSearchSession

VoteSearchSession getVoteSearchSession()
                                       throws OperationFailedException

Gets the OsidSession associated with the vote search service.

Returns:

a VoteSearchSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsVoteSearch() is false

Compliance:

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

getVoteSearchSessionForPolls

VoteSearchSession getVoteSearchSessionForPolls(Id pollsId)
                                               throws NotFoundException,
                                                      OperationFailedException

Gets the OsidSession associated with the vote search service for the given polls.

Parameters:

pollsId - the Id of the Polls

Returns:

a VoteSearchSession

Throws:

NotFoundException - no polls found by the given Id

NullArgumentException - pollsId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsVoteSearch() or supportsVisibleFederation() is false

Compliance:

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

getVoteNotificationSession

VoteNotificationSession getVoteNotificationSession(VoteReceiver voteReceiver)
                                                   throws OperationFailedException

Gets the OsidSession associated with the vote notification service.

Parameters:

voteReceiver - the notification callback

Returns:

a VoteNotificationSession

Throws:

NullArgumentException - voteReceiver is null

OperationFailedException - unable to complete request

UnimplementedException - supportsVoteNotification() is false

Compliance:

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

getVoteNotificationSessionForPolls

VoteNotificationSession getVoteNotificationSessionForPolls(VoteReceiver voteReceiver,
                                                         Id pollsId)
                                                           throws NotFoundException,
                                                                  OperationFailedException

Gets the OsidSession associated with the vote notification service for the given polls.

Parameters:

voteReceiver - the notification callback

pollsId - the Id of the Polls

Returns:

a VoteNotificationSession

Throws:

NotFoundException - no polls found by the given Id

NullArgumentException - voteReceiver or pollsId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsVoteNotification() or supportsVisibleFederation() is false

Compliance:

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

getVotePollsSession

VotePollsSession getVotePollsSession()
                                     throws OperationFailedException

Gets the session for retrieving vote to polls mappings.

Returns:

a VotePollsSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsVotePolls() is false

Compliance:

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

getVotePollsAssignmentSession

VotePollsAssignmentSession getVotePollsAssignmentSession()
                                                         throws OperationFailedException

Gets the session for assigning votes to polls mappings.

Returns:

a VotePollsAssignmentSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsVotePollsAssignment() is false

Compliance:

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

getVoteSmartPollsSession

VoteSmartPollsSession getVoteSmartPollsSession(Id pollsId)
                                               throws NotFoundException,
                                                      OperationFailedException

Gets the session for managing dynamic vote polls.

Parameters:

pollsId - the Id of the polls

Returns:

a VoteSmartPollsSession

Throws:

NotFoundException - pollsId not found

NullArgumentException - pollsId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsVoteSmartPolls() is false

Compliance:

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

getCandidateLookupSession

CandidateLookupSession getCandidateLookupSession()
                                                 throws OperationFailedException

Gets the OsidSession associated with the candidate lookup service.

Returns:

a CandidateLookupSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsCandidateLookup() is false

Compliance:

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

getCandidateLookupSessionForPolls

CandidateLookupSession getCandidateLookupSessionForPolls(Id pollsId)
                                                         throws NotFoundException,
                                                                OperationFailedException

Gets the OsidSession associated with the candidate lookup service for the given polls.

Parameters:

pollsId - the Id of the polls

Returns:

a CandidateLookupSession

Throws:

NotFoundException - pollsId not found

NullArgumentException - pollsId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCandidateLookup() or supportsVisibleFederation() is false

Compliance:

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

getCandidateQuerySession

CandidateQuerySession getCandidateQuerySession()
                                               throws OperationFailedException

Gets a candidate query session.

Returns:

a CandidateQuerySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsCandidateQuery() is false

Compliance:

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

getCandidateQuerySessionForPolls

CandidateQuerySession getCandidateQuerySessionForPolls(Id pollsId)
                                                       throws NotFoundException,
                                                              OperationFailedException

Gets a candidate query session for the given polls.

Parameters:

pollsId - the Id of the polls

Returns:

a CandidateQuerySession

Throws:

NotFoundException - pollsId not found

NullArgumentException - pollsId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCandidateQuery() or supportsVisibleFederation() is false

Compliance:

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

getCandidateSearchSession

CandidateSearchSession getCandidateSearchSession()
                                                 throws OperationFailedException

Gets a candidate search session.

Returns:

a CandidateSearchSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsCandidateSearch() is false

Compliance:

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

getCandidateSearchSessionForPolls

CandidateSearchSession getCandidateSearchSessionForPolls(Id pollsId)
                                                         throws NotFoundException,
                                                                OperationFailedException

Gets a candidate search session for the given polls.

Parameters:

pollsId - the Id of the polls

Returns:

a CandidateSearchSession

Throws:

NotFoundException - pollsId not found

NullArgumentException - pollsId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCandidateSearch() or supportsVisibleFederation() is false

Compliance:

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

getCandidateAdminSession

CandidateAdminSession getCandidateAdminSession()
                                               throws OperationFailedException

Gets a candidate administration session for creating, updating and deleting candidates.

Returns:

a CandidateAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsCandidateAdmin() is false

Compliance:

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

getCandidateAdminSessionForPolls

CandidateAdminSession getCandidateAdminSessionForPolls(Id pollsId)
                                                       throws NotFoundException,
                                                              OperationFailedException

Gets a candidate administration session for the given polls.

Parameters:

pollsId - the Id of the polls

Returns:

a CandidateAdminSession

Throws:

NotFoundException - pollsId not found

NullArgumentException - pollsId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCandidateAdmin() or supportsVisibleFederation() is false

Compliance:

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

getCandidateNotificationSession

CandidateNotificationSession getCandidateNotificationSession(CandidateReceiver candidateReceiver)
                                                             throws OperationFailedException

Gets the notification session for notifications pertaining to candidate changes.

Parameters:

candidateReceiver - the notification callback

Returns:

a CandidateNotificationSession

Throws:

NullArgumentException - candidateReceiver is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCandidateNotification() is false

Compliance:

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

getCandidateNotificationSessionForPolls

CandidateNotificationSession getCandidateNotificationSessionForPolls(CandidateReceiver candidateReceiver,
                                                                   Id pollsId)
                                                                     throws NotFoundException,
                                                                            OperationFailedException

Gets the candidate notification session for the given polls.

Parameters:

candidateReceiver - the notification callback

pollsId - the Id of the polls

Returns:

a CandidateNotificationSession

Throws:

NotFoundException - pollsId not found

NullArgumentException - candidateReceiver or pollsId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCandidateNotification() or supportsVisibleFederation() is false

Compliance:

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

getCandidatePollsSession

CandidatePollsSession getCandidatePollsSession()
                                               throws OperationFailedException

Gets the session for retrieving candidate to polls mappings.

Returns:

a CandidatePollsSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsCandidatePolls() is false

Compliance:

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

getCandidatePollsAssignmentSession

CandidatePollsAssignmentSession getCandidatePollsAssignmentSession()
                                                                   throws OperationFailedException

Gets the session for assigning candidate to polls mappings.

Returns:

a CandidatePollsAssignmentSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsCandidatePollsAssignment() is false

Compliance:

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

getCandidateSmartPollsSession

CandidateSmartPollsSession getCandidateSmartPollsSession(Id pollsId)
                                                         throws NotFoundException,
                                                                OperationFailedException

Gets the session for managing dynamic candidate polls.

Parameters:

pollsId - the Id of the polls

Returns:

a CandidateSmartPollsSession

Throws:

NotFoundException - pollsId not found

NullArgumentException - pollsId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCandidateSmartPolls() is false

Compliance:

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

getRaceLookupSession

RaceLookupSession getRaceLookupSession()
                                       throws OperationFailedException

Gets the OsidSession associated with the race lookup service.

Returns:

a RaceLookupSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsRaceLookup() is false

Compliance:

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

getRaceLookupSessionForPolls

RaceLookupSession getRaceLookupSessionForPolls(Id pollsId)
                                               throws NotFoundException,
                                                      OperationFailedException

Gets the OsidSession associated with the race lookup service for the given polls.

Parameters:

pollsId - the Id of the Polls

Returns:

a RaceLookupSession

Throws:

NotFoundException - no Polls found by the given Id

NullArgumentException - pollsId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRaceLookup() or supportsVisibleFederation() is false

Compliance:

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

getRaceQuerySession

RaceQuerySession getRaceQuerySession()
                                     throws OperationFailedException

Gets the OsidSession associated with the race query service.

Returns:

a RaceQuerySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsRaceQuery() is false

Compliance:

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

getRaceQuerySessionForPolls

RaceQuerySession getRaceQuerySessionForPolls(Id pollsId)
                                             throws NotFoundException,
                                                    OperationFailedException

Gets the OsidSession associated with the race query service for the given polls.

Parameters:

pollsId - the Id of the Polls

Returns:

a RaceQuerySession

Throws:

NotFoundException - no Polls found by the given Id

NullArgumentException - pollsId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRaceQuery() or supportsVisibleFederation() is false

Compliance:

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

getRaceSearchSession

RaceSearchSession getRaceSearchSession()
                                       throws OperationFailedException

Gets the OsidSession associated with the race search service.

Returns:

a RaceSearchSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsRaceSearch() is false

Compliance:

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

getRaceSearchSessionForPolls

VoteSearchSession getRaceSearchSessionForPolls(Id pollsId)
                                               throws NotFoundException,
                                                      OperationFailedException

Gets the OsidSession associated with the race search service for the given polls.

Parameters:

pollsId - the Id of the Polls

Returns:

a RaceSearchSession

Throws:

NotFoundException - no polls found by the given Id

NullArgumentException - pollsId is null

OperationFailedException - unable to complete request

UnimplementedException - supporstRaceSearch() or supportsVisibleFederation() is false

Compliance:

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

getRaceAdminSession

RaceAdminSession getRaceAdminSession()
                                     throws OperationFailedException

Gets the OsidSession associated with the race administration service.

Returns:

a RaceAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsRaceAdmin() is false

Compliance:

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

getRaceAdminSessionForPolls

RaceAdminSession getRaceAdminSessionForPolls(Id pollsId)
                                             throws NotFoundException,
                                                    OperationFailedException

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

Parameters:

pollsId - the Id of the Polls

Returns:

a RaceAdminSession

Throws:

NotFoundException - no polls found by the given Id

NullArgumentException - pollsId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRaceAdmin() or supportsVisibleFederation() is false

Compliance:

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

getRaceNotificationSession

RaceNotificationSession getRaceNotificationSession(RaceReceiver raceReceiver)
                                                   throws OperationFailedException

Gets the OsidSession associated with the race notification service.

Parameters:

raceReceiver - the notification callback

Returns:

a RaceNotificationSession

Throws:

NullArgumentException - raceReceiver is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRaceNotification() is false

Compliance:

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

getRaceNotificationSessionForPolls

RaceNotificationSession getRaceNotificationSessionForPolls(RaceReceiver raceReceiver,
                                                         Id pollsId)
                                                           throws NotFoundException,
                                                                  OperationFailedException

Gets the OsidSession associated with the race notification service for the given polls.

Parameters:

raceReceiver - the notification callback

pollsId - the Id of the Polls

Returns:

a RaceNotificationSession

Throws:

NotFoundException - no polls found by the given Id

NullArgumentException - raceReceiver or pollsId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRaceNotification() or supportsVisibleFederation() is false

Compliance:

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

getRacePollsSession

RacePollsSession getRacePollsSession()
                                     throws OperationFailedException

Gets the session for retrieving race to polls mappings.

Returns:

a RacePollsSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsRacePolls() is false

Compliance:

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

getRacePollsAssignmentSession

RacePollsAssignmentSession getRacePollsAssignmentSession()
                                                         throws OperationFailedException

Gets the session for assigning race to polls mappings.

Returns:

a RacePollsAssignmentSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsRacePollsAssignment() is false

Compliance:

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

getRaceSmartPollsSession

RaceSmartPollsSession getRaceSmartPollsSession(Id pollsId)
                                               throws NotFoundException,
                                                      OperationFailedException

Gets the session for managing dynamic race polls.

Parameters:

pollsId - the Id of the polls

Returns:

a RaceSmartPollsSession

Throws:

NotFoundException - pollsId not found

NullArgumentException - pollsId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRaceSmartPolls() is false

Compliance:

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

getBallotLookupSession

BallotLookupSession getBallotLookupSession()
                                           throws OperationFailedException

Gets the OsidSession associated with the ballot lookup service.

Returns:

a BallotLookupSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsBallotLookup() is false

Compliance:

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

getBallotLookupSessionForPolls

BallotLookupSession getBallotLookupSessionForPolls(Id pollsId)
                                                   throws NotFoundException,
                                                          OperationFailedException

Gets the OsidSession associated with the ballot lookup service for the given polls.

Parameters:

pollsId - the Id of the Polls

Returns:

a BallotLookupSession

Throws:

NotFoundException - no Polls found by the given Id

NullArgumentException - pollsId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsBallotLookup() or supportsVisibleFederation() is false

Compliance:

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

getBallotQuerySession

BallotQuerySession getBallotQuerySession()
                                         throws OperationFailedException

Gets the OsidSession associated with the ballot query service.

Returns:

a BallotQuerySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsBallotQuery() is false

Compliance:

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

getBallotQuerySessionForPolls

BallotQuerySession getBallotQuerySessionForPolls(Id pollsId)
                                                 throws NotFoundException,
                                                        OperationFailedException

Gets the OsidSession associated with the ballot query service for the given polls.

Parameters:

pollsId - the Id of the Polls

Returns:

a BallotQuerySession

Throws:

NotFoundException - no Polls found by the given Id

NullArgumentException - pollsId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsBallotQuery() or supportsVisibleFederation() is false

Compliance:

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

getBallotSearchSession

BallotSearchSession getBallotSearchSession()
                                           throws OperationFailedException

Gets the OsidSession associated with the ballot search service.

Returns:

a RaceSearchSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsRaceSearch() is false

Compliance:

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

getBallotSearchSessionForPolls

BallotSearchSession getBallotSearchSessionForPolls(Id pollsId)
                                                   throws NotFoundException,
                                                          OperationFailedException

Gets the OsidSession associated with the ballot search service for the given polls.

Parameters:

pollsId - the Id of the Polls

Returns:

a BallotSearchSession

Throws:

NotFoundException - no polls found by the given Id

NullArgumentException - pollsId is null

OperationFailedException - unable to complete request

UnimplementedException - supporstBallotSearch() or supportsVisibleFederation() is false

Compliance:

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

getBallotAdminSession

BallotAdminSession getBallotAdminSession()
                                         throws OperationFailedException

Gets the OsidSession associated with the ballot administration service.

Returns:

a BallotAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsBallotAdmin() is false

Compliance:

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

getBallotAdminSessionForPolls

BallotAdminSession getBallotAdminSessionForPolls(Id pollsId)
                                                 throws NotFoundException,
                                                        OperationFailedException

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

Parameters:

pollsId - the Id of the Polls

Returns:

a BallotAdminSession

Throws:

NotFoundException - no polls found by the given Id

NullArgumentException - pollsId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsBallotAdmin() or supportsVisibleFederation() is false

Compliance:

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

getBallotNotificationSession

BallotNotificationSession getBallotNotificationSession(BallotReceiver ballotReceiver)
                                                       throws OperationFailedException

Gets the OsidSession associated with the ballot notification service.

Parameters:

ballotReceiver - the notification callback

Returns:

a BallotNotificationSession

Throws:

NullArgumentException - ballotReceiver is null

OperationFailedException - unable to complete request

UnimplementedException - supportsBallotNotification() is false

Compliance:

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

getBallotNotificationSessionForPolls

BallotNotificationSession getBallotNotificationSessionForPolls(BallotReceiver ballotReceiver,
                                                             Id pollsId)
                                                               throws NotFoundException,
                                                                      OperationFailedException

Gets the OsidSession associated with the ballot notification service for the given polls.

Parameters:

ballotReceiver - the notification callback

pollsId - the Id of the Polls

Returns:

a BallotNotificationSession

Throws:

NotFoundException - no polls found by the given Id

NullArgumentException - ballotReceiver or pollsId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsBallotNotification() or supportsVisibleFederation() is false

Compliance:

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

getBallotPollsSession

BallotPollsSession getBallotPollsSession()
                                         throws OperationFailedException

Gets the session for retrieving ballot to polls mappings.

Returns:

a BallotPollsSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsBallotPolls() is false

Compliance:

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

getBallotPollsAssignmentSession

BallotPollsAssignmentSession getBallotPollsAssignmentSession()
                                                             throws OperationFailedException

Gets the session for assigning ballot to polls mappings.

Returns:

a BallotPollsAssignmentSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsBallotPollsAssignment() is false

Compliance:

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

getBallotSmartPollsSession

BallotSmartPollsSession getBallotSmartPollsSession(Id pollsId)
                                                   throws NotFoundException,
                                                          OperationFailedException

Gets the session for managing dynamic ballot polls.

Parameters:

pollsId - the Id of the polls

Returns:

a BallotSmartPollsSession

Throws:

NotFoundException - pollsId not found

NullArgumentException - pollsId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsBallotSmartPolls() is false

Compliance:

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

getPollsLookupSession

PollsLookupSession getPollsLookupSession()
                                         throws OperationFailedException

Gets the polls lookup session.

Returns:

a PollsLookupSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsPollsLookup() is false

Compliance:

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

getPollsQuerySession

PollsQuerySession getPollsQuerySession()
                                       throws OperationFailedException

Gets the polls query session.

Returns:

a PollsQuerySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsPollsQuery() is false

Compliance:

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

getPollsSearchSession

PollsSearchSession getPollsSearchSession()
                                         throws OperationFailedException

Gets the polls search session.

Returns:

a PollsSearchSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsPollsSearch() is false

Compliance:

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

getPollsAdminSession

PollsAdminSession getPollsAdminSession()
                                       throws OperationFailedException

Gets the polls administrative session for creating, updating and deleteing polls.

Returns:

a PollsAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsPollsAdmin() is false

Compliance:

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

getPollsNotificationSession

PollsNotificationSession getPollsNotificationSession(PollsReceiver pollsReceiver)
                                                     throws OperationFailedException

Gets the notification session for subscripollsg to changes to a polls.

Parameters:

pollsReceiver - the notification callback

Returns:

a PollsNotificationSession

Throws:

NullArgumentException - pollsReceiver is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPollsNotification() is false

Compliance:

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

getPollsHierarchySession

PollsHierarchySession getPollsHierarchySession()
                                               throws OperationFailedException

Gets the polls hierarchy traversal session.

Returns:

a PollsHierarchySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsPollsHierarchy() is false

Compliance:

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

getPollsHierarchyDesignSession

PollsHierarchyDesignSession getPollsHierarchyDesignSession()
                                                           throws OperationFailedException

Gets the polls hierarchy design session.

Returns:

a PollsHierarchyDesignSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsPollsHierarchyDesign() is false

Compliance:

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

getVotingBatchManager

VotingBatchManager getVotingBatchManager()
                                         throws OperationFailedException

Gets a VotingBatchManager.

Returns:

a VotingBatchManager

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsVotingBatch() is false

Compliance:

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

getVotingRulesManager

VotingRulesManager getVotingRulesManager()
                                         throws OperationFailedException

Gets a VotingRulesManager.

Returns:

a VotingRulesManager

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsVotingRules() is false

Compliance:

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