Interface VotingProxyManager

All Superinterfaces:

AutoCloseable, Closeable, OsidProfile, OsidProxyManager, OsidProxyManager, Sourceable, VotingProfile

public interface VotingProxyManager
extends OsidProxyManager, VotingProfile

The candidate manager provides access to candidate lookup and creation session and provides interoperability tests for various aspects of this service. Methods in this manager accept a Proxy . 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

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

Methods inherited from interface Closeable

close

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 OsidProxyManager

close

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

Methods inherited from interface OsidProxyManager

changeBranch, initialize, rollbackService

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

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

Modifier and Type	Method	Description
TypeList	getBallotRecordTypes()	Gets the supported Ballot record types.
TypeList	getBallotSearchRecordTypes()	Gets the supported Ballot search record types.
TypeList	getCandidateRecordTypes()	Gets all the candidate record types supported.
TypeList	getCandidateSearchRecordTypes()	Gets all the candidate search record types supported.
TypeList	getPollsRecordTypes()	Gets all the polls record types supported.
TypeList	getPollsSearchRecordTypes()	Gets all the polls search record types supported.
TypeList	getRaceRecordTypes()	Gets the supported Race record types.
TypeList	getRaceSearchRecordTypes()	Gets the supported Race search record types.
TypeList	getVoterAllocationRecordTypes()	Gets the supported VoterAllocation record types.
TypeList	getVoteRecordTypes()	Gets the supported Vote record types.
TypeList	getVoteSearchRecordTypes()	Gets the supported Vote search record types.
TypeList	getVotingResultsRecordTypes()	Gets the supported VotingResults record types.
boolean	supportsBallotAdmin()	Tests if a ballot a dministrative service is supported.
boolean	supportsBallotLookup()	Tests if looking up ballots is supported.
boolean	supportsBallotNotification()	Tests if a ballot notification service is supported.
boolean	supportsBallotPolls()	Tests if retrieving mappings of ballots and polls is supported.
boolean	supportsBallotPollsAssignment()	Tests if managing mappings of ballots and polls is supported.
boolean	supportsBallotQuery()	Tests if querying ballots is supported.
boolean	supportsBallotRecordType(Type ballotRecordType)	Tests if the given Ballot record type is supported.
boolean	supportsBallotSearch()	Tests if searching ballots is supported.
boolean	supportsBallotSearchRecordType(Type ballotSearchRecordType)	Tests if the given Ballot search record type is supported.
boolean	supportsBallotSmartPolls()	Tests if ballot smart polls are available.
boolean	supportsCandidateAdmin()	Tests if candidate administration is supported.
boolean	supportsCandidateLookup()	Tests if candidate lookup is supported.
boolean	supportsCandidateNotification()	Tests if candidate notification is supported.
boolean	supportsCandidatePolls()	Tests if retrieving mappings of candidate and polls is supported.
boolean	supportsCandidatePollsAssignment()	Tests if managing mappings of candidate and polls is supported.
boolean	supportsCandidateQuery()	Tests if candidate query is supported.
boolean	supportsCandidateRecordType(Type candidateRecordType)	Tests if a given candidate record type is supported.
boolean	supportsCandidateSearch()	Tests if candidate search is supported.
boolean	supportsCandidateSearchRecordType(Type candidateSearchRecordType)	Tests if a given candidate search type is supported.
boolean	supportsCandidateSmartPolls()	Tests if candidate smart polls are available.
boolean	supportsPollsAdmin()	Tests if polls administration is supported.
boolean	supportsPollsHierarchy()	Tests if a polls hierarchy traversal is supported.
boolean	supportsPollsHierarchyDesign()	Tests if a polls hierarchy design is supported.
boolean	supportsPollsLookup()	Tests if polls lookup is supported.
boolean	supportsPollsNotification()	Tests if polls notification is supported.
boolean	supportsPollsQuery()	Tests if polls query is supported.
boolean	supportsPollsRecordType(Type pollsRecordType)	Tests if a given polls record type is supported.
boolean	supportsPollsSearch()	Tests if polls search is supported.
boolean	supportsPollsSearchRecordType(Type pollsSearchRecordType)	Tests if a given polls search record type is supported.
boolean	supportsRaceAdmin()	Tests if a race a dministrative service is supported.
boolean	supportsRaceLookup()	Tests if looking up races is supported.
boolean	supportsRaceNotification()	Tests if a race notification service is supported.
boolean	supportsRacePolls()	Tests if retrieving mappings of races and polls is supported.
boolean	supportsRacePollsAssignment()	Tests if managing mappings of races and polls is supported.
boolean	supportsRaceQuery()	Tests if querying races is supported.
boolean	supportsRaceRecordType(Type raceRecordType)	Tests if the given Race record type is supported.
boolean	supportsRaceResults()	Tests if race results is supported.
boolean	supportsRaceSearch()	Tests if searching races is supported.
boolean	supportsRaceSearchRecordType(Type raceSearchRecordType)	Tests if the given Race search record type is supported.
boolean	supportsRaceSmartPolls()	Tests if race smart polls are available.
boolean	supportsVisibleFederation()	Tests if federation is visible.
boolean	supportsVoteLookup()	Tests if looking up votes is supported.
boolean	supportsVoteNotification()	Tests if a votes notification service is supported.
boolean	supportsVotePolls()	Tests if retrieving mappings of votes and polls is supported.
boolean	supportsVotePollsAssignment()	Tests if managing mappings of votes and polls is supported.
boolean	supportsVoteQuery()	Tests if querying votes is supported.
boolean	supportsVoterAllocationRecordType(Type voterAllocationRecordType)	Tests if the given VoterAllocation record type is supported.
boolean	supportsVoteRecordType(Type voteRecordType)	Tests if the given Vote record type is supported.
boolean	supportsVoteSearch()	Tests if searching votes is supported.
boolean	supportsVoteSearchRecordType(Type voteSearchRecordType)	Tests if the given Vote search record type is supported.
boolean	supportsVoteSmartPolls()	Tests if vote smart polls are available.
boolean	supportsVoting()	Tests if voting is supported.
boolean	supportsVotingAllocationAdmin()	Tests if voting allocation administration is supported.
boolean	supportsVotingAllocationLookup()	Tests if voting allocation lookup is supported.
boolean	supportsVotingBatch()	Tests if a voting batch service is supported.
boolean	supportsVotingResultsRecordType(Type votingResultsRecordType)	Tests if the given VotingResults record type is supported.
boolean	supportsVotingRules()	Tests if a voting rules service is supported.

Method Details

getVotingSession

VotingSession getVotingSession(Proxy proxy)
                        throws OperationFailedException

Gets the OsidSession associated with the voting service.

Parameters:

proxy - a proxy

Returns:

a VotingSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsVoting() is false

Compliance:

optional - This method must be implemented if {@code supportsVoting()} is {@code true} .

getVotingSessionForPolls

VotingSession getVotingSessionForPolls(Id pollsId,
 Proxy proxy)
                                throws NotFoundException,
OperationFailedException

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

Parameters:

pollsId - the Id of the Polls

proxy - a proxy

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 {@code supportsVoting()} and {@code supportsVisibleFederation()} are {@code true}

getRaceResultsSession

RaceResultsSession getRaceResultsSession(Proxy proxy)
                                  throws OperationFailedException

Gets the OsidSession associated with the race results service.

Parameters:

proxy - a proxy

Returns:

a RaceResultsSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRaceResults() is false

Compliance:

optional - This method must be implemented if {@code supportsRaceResults()} is {@code true} .

getRaceResultsSessionForPolls

RaceResultsSession getRaceResultsSessionForPolls(Id pollsId,
 Proxy proxy)
                                          throws NotFoundException,
OperationFailedException

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

Parameters:

pollsId - the Id of the Polls

proxy - a proxy

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 {@code supportsRaceResults()} and {@code supportsVisibleFederation()} are {@code true}

getVoterAllocationLookupSession

VoterAllocationLookupSession getVoterAllocationLookupSession(Proxy proxy)
                                                      throws OperationFailedException

Gets the OsidSession associated with the voter allocation lookup service.

Parameters:

proxy - a proxy

Returns:

a VoterAllocationLookupSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsVoterAllocationLookup() is false

Compliance:

optional - This method must be implemented if {@code supportsVoterAllocationLookup()} is {@code true} .

getVoterAllocationLookupSessionForPolls

VoterAllocationLookupSession getVoterAllocationLookupSessionForPolls(Id pollsId,
 Proxy proxy)
                                                              throws NotFoundException,
OperationFailedException

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

Parameters:

pollsId - the Id of the Polls

proxy - a proxy

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 {@code supportsVoterAllocationLookup()} and {@code supportsVisibleFederation()} are {@code true}

getVoterAllocationAdminSession

VoterAllocationAdminSession getVoterAllocationAdminSession(Proxy proxy)
                                                    throws OperationFailedException

Gets the OsidSession associated with the voter allocation administrative service.

Parameters:

proxy - a proxy

Returns:

a VoterAllocationAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsVoterAllocationAdmin() is false

Compliance:

optional - This method must be implemented if {@code supportsVoterAllocationAdmin()} is {@code true} .

getVoterAllocationAdminSessionForPolls

VoterAllocationAdminSession getVoterAllocationAdminSessionForPolls(Id pollsId,
 Proxy proxy)
                                                            throws NotFoundException,
OperationFailedException

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

Parameters:

pollsId - the Id of the Polls

proxy - a proxy

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 {@code supportsVoterAllocationAdmin()} and {@code supportsVisibleFederation()} are {@code true}

getVoteLookupSession

VoteLookupSession getVoteLookupSession(Proxy proxy)
                                throws OperationFailedException

Gets the OsidSession associated with the vote lookup service.

Parameters:

proxy - a proxy

Returns:

a VoteLookupSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsVoteLookup() is false

Compliance:

optional - This method must be implemented if {@code supportsVoteLookup()} is {@code true} .

getVoteLookupSessionForPolls

VoteLookupSession getVoteLookupSessionForPolls(Id pollsId,
 Proxy proxy)
                                        throws NotFoundException,
OperationFailedException

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

Parameters:

pollsId - the Id of the Polls

proxy - a proxy

Returns:

a VoteLookupSession

Throws:

NotFoundException - no Polls found by the given Id

NullArgumentException - pollsId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsVoteLookup() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsVoteLookup()} and {@code supportsVisibleFederation()} are {@code true}

getVoteQuerySession

VoteQuerySession getVoteQuerySession(Proxy proxy)
                              throws OperationFailedException

Gets the OsidSession associated with the vote query service.

Parameters:

proxy - a proxy

Returns:

a VoteQuerySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsVoteQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsVoteQuery()} is {@code true} .

getVoteQuerySessionForPolls

VoteQuerySession getVoteQuerySessionForPolls(Id pollsId,
 Proxy proxy)
                                      throws NotFoundException,
OperationFailedException

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

Parameters:

pollsId - the Id of the Polls

proxy - a proxy

Returns:

a VoteQuerySession

Throws:

NotFoundException - no Polls found by the given Id

NullArgumentException - pollsId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsVoteQuery() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsVoteQuery()} and {@code supportsVisibleFederation()} are {@code true}

getVoteSearchSession

VoteSearchSession getVoteSearchSession(Proxy proxy)
                                throws OperationFailedException

Gets the OsidSession associated with the vote search service.

Parameters:

proxy - a proxy

Returns:

a VoteSearchSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsVoteSearch() is false

Compliance:

optional - This method must be implemented if {@code supportsVoteSearch()} is {@code true} .

getVoteSearchSessionForPolls

VoteSearchSession getVoteSearchSessionForPolls(Id pollsId,
 Proxy proxy)
                                        throws NotFoundException,
OperationFailedException

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

Parameters:

pollsId - the Id of the Polls

proxy - a proxy

Returns:

a VoteSearchSession

Throws:

NotFoundException - no polls found by the given Id

NullArgumentException - pollsId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsVoteSearch() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsVoteSearch()} and {@code supportsVisibleFederation()} are {@code true}

getVoteNotificationSession

VoteNotificationSession getVoteNotificationSession(VoteReceiver voteReceiver,
 Proxy proxy)
                                            throws OperationFailedException

Gets the OsidSession associated with the vote notification service.

Parameters:

voteReceiver - the notification callback

proxy - a proxy

Returns:

a VoteNotificationSession

Throws:

NullArgumentException - voteReceiver or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsVoteNotification() is false

Compliance:

optional - This method must be implemented if {@code supportsVoteNotification()} is {@code true} .

getVoteNotificationSessionForPolls

VoteNotificationSession getVoteNotificationSessionForPolls(VoteReceiver voteReceiver,
 Id pollsId,
 Proxy proxy)
                                                    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

proxy - a proxy

Returns:

a VoteNotificationSession

Throws:

NotFoundException - no polls found by the given Id

NullArgumentException - voteReceiver, pollsId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsVoteNotification() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsVoteNotification()} and {@code supportsVisibleFederation()} are {@code true}

getVotePollsSession

VotePollsSession getVotePollsSession(Proxy proxy)
                              throws OperationFailedException

Gets the session for retrieving vote to polls mappings.

Parameters:

proxy - a proxy

Returns:

a Vote PollsSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsVotePolls() is false

Compliance:

optional - This method must be implemented if {@code supportsVotePolls()} is {@code true} .

getVotePollsAssignmentSession

VotePollsAssignmentSession getVotePollsAssignmentSession(Proxy proxy)
                                                  throws OperationFailedException

Gets the session for assigning votes to polls mappings.

Parameters:

proxy - a proxy

Returns:

a VotePollsAssignmentSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsVotePollsAssignment() is false

Compliance:

optional - This method must be implemented if {@code supportsVotePollsAssignment()} is {@code true} .

getVoteSmartPollsSession

VoteSmartPollsSession getVoteSmartPollsSession(Id pollsId,
 Proxy proxy)
                                        throws NotFoundException,
OperationFailedException

Gets the session for managing dynamic vote polls.

Parameters:

pollsId - the Id of the polls

proxy - a proxy

Returns:

a VoteSmartPollsSession

Throws:

NotFoundException - pollsId not found

NullArgumentException - pollsId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsVoteSmartPolls() is false

Compliance:

optional - This method must be implemented if {@code supportsVoteSmartPolls()} is {@code true} .

getCandidateLookupSession

CandidateLookupSession getCandidateLookupSession(Proxy proxy)
                                          throws OperationFailedException

Gets the OsidSession associated with the candidate lookup service.

Parameters:

proxy - a proxy

Returns:

a CandidateLookupSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCandidateLookup() is false

Compliance:

optional - This method must be implemented if {@code supportsCandidateLookup()} is {@code true} .

getCandidateLookupSessionForPolls

CandidateLookupSession getCandidateLookupSessionForPolls(Id pollsId,
 Proxy proxy)
                                                  throws NotFoundException,
OperationFailedException

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

Parameters:

pollsId - the Id of the polls

proxy - a proxy

Returns:

a CandidateLookupSession

Throws:

NotFoundException - pollsId not found

NullArgumentException - pollsId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCandidateLookup() or supportsVisibleFederation() is false

Compliance:

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

getCandidateQuerySession

CandidateQuerySession getCandidateQuerySession(Proxy proxy)
                                        throws OperationFailedException

Gets a candidate query session.

Parameters:

proxy - a proxy

Returns:

a CandidateQuerySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCandidateQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsCandidateQuery()} is {@code true} .

getCandidateQuerySessionForPolls

CandidateQuerySession getCandidateQuerySessionForPolls(Id pollsId,
 Proxy proxy)
                                                throws NotFoundException,
OperationFailedException

Gets a candidate query session for the given polls.

Parameters:

pollsId - the Id of the polls

proxy - a proxy

Returns:

a CandidateQuerySession

Throws:

NotFoundException - pollsId not found

NullArgumentException - pollsId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCandidateQuery() or supportsVisibleFederation() is false

Compliance:

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

getCandidateSearchSession

CandidateSearchSession getCandidateSearchSession(Proxy proxy)
                                          throws OperationFailedException

Gets a candidate search session.

Parameters:

proxy - a proxy

Returns:

a CandidateSearchSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCandidateSearch() is false

Compliance:

optional - This method must be implemented if {@code supportsCandidateSearch()} is {@code true} .

getCandidateSearchSessionForPolls

CandidateSearchSession getCandidateSearchSessionForPolls(Id pollsId,
 Proxy proxy)
                                                  throws NotFoundException,
OperationFailedException

Gets a candidate search session for the given polls.

Parameters:

pollsId - the Id of the polls

proxy - a proxy

Returns:

a CandidateSearchSession

Throws:

NotFoundException - pollsId not found

NullArgumentException - pollsId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCandidateSearch() or supportsVisibleFederation() is false

Compliance:

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

getCandidateAdminSession

CandidateAdminSession getCandidateAdminSession(Proxy proxy)
                                        throws OperationFailedException

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

Parameters:

proxy - a proxy

Returns:

a CandidateAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCandidateAdmin() is false

Compliance:

optional - This method must be implemented if {@code supportsCandidateAdmin()} is {@code true} .

getCandidateAdminSessionForPolls

CandidateAdminSession getCandidateAdminSessionForPolls(Id pollsId,
 Proxy proxy)
                                                throws NotFoundException,
OperationFailedException

Gets a candidate administration session for the given polls.

Parameters:

pollsId - the Id of the polls

proxy - a proxy

Returns:

a CandidateAdminSession

Throws:

NotFoundException - pollsId not found

NullArgumentException - pollsId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCandidateAdmin() or supportsVisibleFederation() is false

Compliance:

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

getCandidateNotificationSession

CandidateNotificationSession getCandidateNotificationSession(CandidateReceiver candidateReceiver,
 Proxy proxy)
                                                      throws OperationFailedException

Gets the notification session for notifications pertaining to candidate changes.

Parameters:

candidateReceiver - the notification callback

proxy - a proxy

Returns:

a CandidateNotificationSession

Throws:

NullArgumentException - candidateReceiver or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCandidateNotification() is false

Compliance:

optional - This method must be implemented if {@code supportsCandidateNotification()} is {@code true} .

getCandidateNotificationSessionForPolls

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

Gets the candidate notification session for the given polls.

Parameters:

candidateReceiver - the notification callback

pollsId - the Id of the polls

proxy - a proxy

Returns:

a CandidateNotificationSession

Throws:

NotFoundException - pollsId not found

NullArgumentException - candidateReceiver, pollsId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCandidateNotification() or supportsVisibleFederation() is false

Compliance:

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

getCandidatePollsSession

CandidatePollsSession getCandidatePollsSession(Proxy proxy)
                                        throws OperationFailedException

Gets the session for retrieving candidate to polls mappings.

Parameters:

proxy - a proxy

Returns:

a CandidatePollsSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCandidatePolls() is false

Compliance:

optional - This method must be implemented if {@code supportsCandidatePolls()} is {@code true} .

getCandidatePollsAssignmentSession

CandidatePollsAssignmentSession getCandidatePollsAssignmentSession(Proxy proxy)
                                                            throws OperationFailedException

Gets the session for assigning candidate to polls mappings.

Parameters:

proxy - a proxy

Returns:

a CandidatePollsAssignmentSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCandidatePollsAssignment() is false

Compliance:

optional - This method must be implemented if {@code supportsCandidatePollsAssignment()} is {@code true} .

getCandidateSmartPollsSession

CandidateSmartPollsSession getCandidateSmartPollsSession(Id pollsId,
 Proxy proxy)
                                                  throws NotFoundException,
OperationFailedException

Gets the session for managing dynamic candidate polls.

Parameters:

pollsId - the Id of the polls

proxy - a proxy

Returns:

a CandidateSmartPollsSession

Throws:

NotFoundException - pollsId not found

NullArgumentException - pollsId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCandidateSmartPolls() is false

Compliance:

optional - This method must be implemented if {@code supportsCandidateSmartPolls()} is {@code true} .

getRaceLookupSession

RaceLookupSession getRaceLookupSession(Proxy proxy)
                                throws OperationFailedException

Gets the OsidSession associated with the race lookup service.

Parameters:

proxy - a proxy

Returns:

a RaceLookupSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRaceLookup() is false

Compliance:

optional - This method must be implemented if {@code supportsRaceLookup()} is {@code true} .

getRaceLookupSessionForPolls

RaceLookupSession getRaceLookupSessionForPolls(Id pollsId,
 Proxy proxy)
                                        throws NotFoundException,
OperationFailedException

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

Parameters:

pollsId - the Id of the Polls

proxy - a proxy

Returns:

a RaceLookupSession

Throws:

NotFoundException - no Polls found by the given Id

NullArgumentException - pollsId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRaceLookup() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsRaceLookup()} and {@code supportsVisibleFederation()} are {@code true}

getRaceQuerySession

RaceQuerySession getRaceQuerySession(Proxy proxy)
                              throws OperationFailedException

Gets the OsidSession associated with the race query service.

Parameters:

proxy - a proxy

Returns:

a RaceQuerySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRaceQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsRaceQuery()} is {@code true} .

getRaceQuerySessionForPolls

RaceQuerySession getRaceQuerySessionForPolls(Id pollsId,
 Proxy proxy)
                                      throws NotFoundException,
OperationFailedException

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

Parameters:

pollsId - the Id of the Polls

proxy - a proxy

Returns:

a RaceQuerySession

Throws:

NotFoundException - no Polls found by the given Id

NullArgumentException - pollsId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRaceQuery() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsRaceQuery()} and {@code supportsVisibleFederation()} are {@code true}

getRaceSearchSession

RaceSearchSession getRaceSearchSession(Proxy proxy)
                                throws OperationFailedException

Gets the OsidSession associated with the race search service.

Parameters:

proxy - a proxy

Returns:

a RaceSearchSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRaceSearch() is false

Compliance:

optional - This method must be implemented if {@code supportsRaceSearch()} is {@code true} .

getRaceSearchSessionForPolls

VoteSearchSession getRaceSearchSessionForPolls(Id pollsId,
 Proxy proxy)
                                        throws NotFoundException,
OperationFailedException

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

Parameters:

pollsId - the Id of the Polls

proxy - a proxy

Returns:

a RaceSearchSession

Throws:

NotFoundException - no polls found by the given Id

NullArgumentException - pollsId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supporstRaceSearch() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsRaceSearch()} and {@code supportsVisibleFederation()} are {@code true}

getRaceAdminSession

RaceAdminSession getRaceAdminSession(Proxy proxy)
                              throws OperationFailedException

Gets the OsidSession associated with the race administration service.

Parameters:

proxy - a proxy

Returns:

a RaceAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRaceAdmin() is false

Compliance:

optional - This method must be implemented if {@code supportsRaceAdmin()} is {@code true} .

getRaceAdminSessionForPolls

RaceAdminSession getRaceAdminSessionForPolls(Id pollsId,
 Proxy proxy)
                                      throws NotFoundException,
OperationFailedException

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

Parameters:

pollsId - the Id of the Polls

proxy - a proxy

Returns:

a RaceAdminSession

Throws:

NotFoundException - no polls found by the given Id

NullArgumentException - pollsId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRaceAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsRaceAdmin()} and {@code supportsVisibleFederation()} are {@code true}

getRaceNotificationSession

RaceNotificationSession getRaceNotificationSession(RaceReceiver raceReceiver,
 Proxy proxy)
                                            throws OperationFailedException

Gets the OsidSession associated with the race notification service.

Parameters:

raceReceiver - the notification callback

proxy - a proxy

Returns:

a RaceNotificationSession

Throws:

NullArgumentException - raceReceiver or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRaceNotification() is false

Compliance:

optional - This method must be implemented if {@code supportsRaceNotification()} is {@code true} .

getRaceNotificationSessionForPolls

RaceNotificationSession getRaceNotificationSessionForPolls(RaceReceiver raceReceiver,
 Id pollsId,
 Proxy proxy)
                                                    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

proxy - a proxy

Returns:

a RaceNotificationSession

Throws:

NotFoundException - no polls found by the given Id

NullArgumentException - raceReceiver, pollsId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRaceNotification() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsRaceNotification()} and {@code supportsVisibleFederation()} are {@code true}

getRacePollsSession

RacePollsSession getRacePollsSession(Proxy proxy)
                              throws OperationFailedException

Gets the session for retrieving race to polls mappings.

Parameters:

proxy - a proxy

Returns:

a RacePollsSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRacePolls() is false

Compliance:

optional - This method must be implemented if {@code supportsRacePolls()} is {@code true} .

getRacePollsAssignmentSession

RacePollsAssignmentSession getRacePollsAssignmentSession(Proxy proxy)
                                                  throws OperationFailedException

Gets the session for assigning race to polls mappings.

Parameters:

proxy - a proxy

Returns:

a RacePollsAssignmentSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRacePollsAssignment() is false

Compliance:

optional - This method must be implemented if {@code supportsRacePollsAssignment()} is {@code true} .

getRaceSmartPollsSession

RaceSmartPollsSession getRaceSmartPollsSession(Id pollsId,
 Proxy proxy)
                                        throws NotFoundException,
OperationFailedException

Gets the session for managing dynamic race polls.

Parameters:

pollsId - the Id of the polls

proxy - a proxy

Returns:

a RaceSmartPollsSession

Throws:

NotFoundException - pollsId not found

NullArgumentException - pollsId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRaceSmartPolls() is false

Compliance:

optional - This method must be implemented if {@code supportsRaceSmartPolls()} is {@code true} .

getBallotLookupSession

BallotLookupSession getBallotLookupSession(Proxy proxy)
                                    throws OperationFailedException

Gets the OsidSession associated with the ballot lookup service.

Parameters:

proxy - a proxy

Returns:

a BallotLookupSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsBallotLookup() is false

Compliance:

optional - This method must be implemented if {@code supportsBallotLookup()} is {@code true} .

getBallotLookupSessionForPolls

BallotLookupSession getBallotLookupSessionForPolls(Id pollsId,
 Proxy proxy)
                                            throws NotFoundException,
OperationFailedException

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

Parameters:

pollsId - the Id of the Polls

proxy - a proxy

Returns:

a BallotLookupSession

Throws:

NotFoundException - no Polls found by the given Id

NullArgumentException - pollsId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsBallotLookup() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsBallotLookup()} and {@code supportsVisibleFederation()} are {@code true}

getBallotQuerySession

BallotQuerySession getBallotQuerySession(Proxy proxy)
                                  throws OperationFailedException

Gets the OsidSession associated with the ballot query service.

Parameters:

proxy - a proxy

Returns:

a BallotQuerySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsBallotQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsBallotQuery()} is {@code true} .

getBallotQuerySessionForPolls

BallotQuerySession getBallotQuerySessionForPolls(Id pollsId,
 Proxy proxy)
                                          throws NotFoundException,
OperationFailedException

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

Parameters:

pollsId - the Id of the Polls

proxy - a proxy

Returns:

a BallotQuerySession

Throws:

NotFoundException - no Polls found by the given Id

NullArgumentException - pollsId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsBallotQuery() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsBallotQuery()} and {@code supportsVisibleFederation()} are {@code true}

getBallotSearchSession

BallotSearchSession getBallotSearchSession(Proxy proxy)
                                    throws OperationFailedException

Gets the OsidSession associated with the ballot search service.

Parameters:

proxy - a proxy

Returns:

a RaceSearchSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRaceSearch() is false

Compliance:

optional - This method must be implemented if {@code supportsBallotSearch()} is {@code true} .

getBallotSearchSessionForPolls

BallotSearchSession getBallotSearchSessionForPolls(Id pollsId,
 Proxy proxy)
                                            throws NotFoundException,
OperationFailedException

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

Parameters:

pollsId - the Id of the Polls

proxy - a proxy

Returns:

a BallotSearchSession

Throws:

NotFoundException - no polls found by the given Id

NullArgumentException - pollsId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supporstBallotSearch() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsBallotSearch()} and {@code supportsVisibleFederation()} are {@code true}

getBallotAdminSession

BallotAdminSession getBallotAdminSession(Proxy proxy)
                                  throws OperationFailedException

Gets the OsidSession associated with the ballot administration service.

Parameters:

proxy - a proxy

Returns:

a BallotAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsBallotAdmin() is false

Compliance:

optional - This method must be implemented if {@code supportsBallotAdmin()} is {@code true} .

getBallotAdminSessionForPolls

BallotAdminSession getBallotAdminSessionForPolls(Id pollsId,
 Proxy proxy)
                                          throws NotFoundException,
OperationFailedException

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

Parameters:

pollsId - the Id of the Polls

proxy - a proxy

Returns:

a BallotAdminSession

Throws:

NotFoundException - no polls found by the given Id

NullArgumentException - pollsId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsBallotAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsBallotAdmin()} and {@code supportsVisibleFederation()} are {@code true}

getBallotNotificationSession

BallotNotificationSession getBallotNotificationSession(BallotReceiver ballotReceiver,
 Proxy proxy)
                                                throws OperationFailedException

Gets the OsidSession associated with the ballot notification service.

Parameters:

ballotReceiver - the notification callback

proxy - a proxy

Returns:

a BallotNotificationSession

Throws:

NullArgumentException - ballotReceiver or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsBallotNotification() is false

Compliance:

optional - This method must be implemented if {@code supportsBallotNotification()} is {@code true} .

getBallotNotificationSessionForPolls

BallotNotificationSession getBallotNotificationSessionForPolls(BallotReceiver ballotReceiver,
 Id pollsId,
 Proxy proxy)
                                                        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

proxy - a proxy

Returns:

a BallotNotificationSession

Throws:

NotFoundException - no polls found by the given Id

NullArgumentException - ballotReceiver, pollsId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsBallotNotification() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsBallotNotification()} and {@code supportsVisibleFederation()} are {@code true}

getBallotPollsSession

BallotPollsSession getBallotPollsSession(Proxy proxy)
                                  throws OperationFailedException

Gets the session for retrieving ballot to polls mappings.

Parameters:

proxy - a proxy

Returns:

a BallotPollsSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsBallotPolls() is false

Compliance:

optional - This method must be implemented if {@code supportsBallotPolls()} is {@code true} .

getBallotPollsAssignmentSession

BallotPollsAssignmentSession getBallotPollsAssignmentSession(Proxy proxy)
                                                      throws OperationFailedException

Gets the session for assigning ballot to polls mappings.

Parameters:

proxy - a proxy

Returns:

a BallotPollsAssignmentSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsBallotPollsAssignment() is false

Compliance:

optional - This method must be implemented if {@code supportsBallotPollsAssignment()} is {@code true} .

getBallotSmartPollsSession

BallotSmartPollsSession getBallotSmartPollsSession(Id pollsId,
 Proxy proxy)
                                            throws NotFoundException,
OperationFailedException

Gets the session for managing dynamic ballot polls.

Parameters:

pollsId - the Id of the polls

proxy - a proxy

Returns:

a BallotSmartPollsSession

Throws:

NotFoundException - pollsId not found

NullArgumentException - pollsId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsBallotSmartPolls() is false

Compliance:

optional - This method must be implemented if {@code supportsBallotSmartPolls()} is {@code true} .

getPollsLookupSession

PollsLookupSession getPollsLookupSession(Proxy proxy)
                                  throws OperationFailedException

Gets the polls lookup session.

Parameters:

proxy - a proxy

Returns:

a PollsLookupSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPollsLookup() is false

Compliance:

optional - This method must be implemented if {@code supportsPollsLookup()} is {@code true} .

getPollsQuerySession

PollsQuerySession getPollsQuerySession(Proxy proxy)
                                throws OperationFailedException

Gets the polls query session.

Parameters:

proxy - a proxy

Returns:

a PollsQuerySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPollsQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsPollsQuery()} is {@code true} .

getPollsSearchSession

PollsSearchSession getPollsSearchSession(Proxy proxy)
                                  throws OperationFailedException

Gets the polls search session.

Parameters:

proxy - a proxy

Returns:

a PollsSearchSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPollsSearch() is false

Compliance:

optional - This method must be implemented if {@code supportsPollsSearch()} is {@code true} .

getPollsAdminSession

PollsAdminSession getPollsAdminSession(Proxy proxy)
                                throws OperationFailedException

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

Parameters:

proxy - a proxy

Returns:

a PollsAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPollsAdmin() is false

Compliance:

optional - This method must be implemented if {@code supportsPollsAdmin()} is {@code true} .

getPollsNotificationSession

PollsNotificationSession getPollsNotificationSession(PollsReceiver pollsReceiver,
 Proxy proxy)
                                              throws OperationFailedException

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

Parameters:

pollsReceiver - the notification callback

proxy - a proxy

Returns:

a PollsNotificationSession

Throws:

NullArgumentException - pollsReceiver or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPollsNotification() is false

Compliance:

optional - This method must be implemented if {@code supportsPollsNotification()} is {@code true} .

getPollsHierarchySession

PollsHierarchySession getPollsHierarchySession(Proxy proxy)
                                        throws OperationFailedException

Gets the polls hierarchy traversal session.

Parameters:

proxy - a proxy

Returns:

a PollsHierarchySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPollsHierarchy() is false

Compliance:

optional - This method must be implemented if {@code supportsPollsHierarchy()} is {@code true} .

getPollsHierarchyDesignSession

PollsHierarchyDesignSession getPollsHierarchyDesignSession(Proxy proxy)
                                                    throws OperationFailedException

Gets the polls hierarchy design session.

Parameters:

proxy - a proxy

Returns:

a PollsHierarchyDesignSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPollsHierarchyDesign() is false

Compliance:

optional - This method must be implemented if {@code supportsPollsHierarchyDesign()} is {@code true} .

getVotingBatchProxyManager

VotingBatchProxyManager getVotingBatchProxyManager()
                                            throws OperationFailedException

Gets a VotingBatchProxyManager .

Returns:

a VotingBatchProxyManager

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsVotingBatch() is false

Compliance:

optional - This method must be implemented if {@code supportsVotingBatch()} is {@code true} .

getVotingRulesProxyManager

VotingRulesProxyManager getVotingRulesProxyManager()
                                            throws OperationFailedException

Gets a VotingRulesProxyManager .

Returns:

a VotingRulesProxyManager

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsVotingRules() is false

Compliance:

optional - This method must be implemented if {@code supportsVotingRules()} is {@code true} .