OSID Logo
OSID Specifications
voting package
Version 3.0.0
Release Candidate Preview
Interfaceosid.voting.VotingProxyManager
Implementsosid.OsidProxyManager
osid.voting.VotingProfile
Description

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

Gets the OsidSession associated with the voting service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.voting.VotingSessiona VotingSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsVoting() is false
ComplianceoptionalThis method must be implemented if supportsVoting() is true.
MethodgetVotingSessionForPolls
Description

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

Parametersosid.id.IdpollsIdthe Id of the Polls
osid.proxy.Proxyproxya proxy
Returnosid.voting.VotingSessiona VotingSession
ErrorsNOT_FOUNDno Polls found by the given Id
NULL_ARGUMENT pollsId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsVoting() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsVoting() and supportsVisibleFederation() are true
MethodgetRaceResultsSession
Description

Gets the OsidSession associated with the race results service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.voting.RaceResultsSessiona RaceResultsSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsRaceResults() is false
ComplianceoptionalThis method must be implemented if supportsRaceResults() is true.
MethodgetRaceResultsSessionForPolls
Description

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

Parametersosid.id.IdpollsIdthe Id of the Polls
osid.proxy.Proxyproxya proxy
Returnosid.voting.RaceResultsSessiona RaceResultsSession
ErrorsNOT_FOUNDno Polls found by the given Id
NULL_ARGUMENT pollsId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsRaceResults() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsRaceResults() and supportsVisibleFederation() are true
MethodgetVoterAllocationLookupSession
Description

Gets the OsidSession associated with the voter allocation lookup service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.voting.VoterAllocationLookupSessiona VoterAllocationLookupSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsVoterAllocationLookup() is false
ComplianceoptionalThis method must be implemented if supportsVoterAllocationLookup() is true.
MethodgetVoterAllocationLookupSessionForPolls
Description

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

Parametersosid.id.IdpollsIdthe Id of the Polls
osid.proxy.Proxyproxya proxy
Returnosid.voting.VoterAllocationLookupSessiona VoterAllocationLookupSession
ErrorsNOT_FOUNDno Polls found by the given Id
NULL_ARGUMENT pollsId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsVoterAllocationLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsVoterAllocationLookup() and supportsVisibleFederation() are true
MethodgetVoterAllocationAdminSession
Description

Gets the OsidSession associated with the voter allocation administrative service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.voting.VoterAllocationAdminSessiona VoterAllocationAdminSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsVoterAllocationAdmin() is false
ComplianceoptionalThis method must be implemented if supportsVoterAllocationAdmin() is true.
MethodgetVoterAllocationAdminSessionForPolls
Description

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

Parametersosid.id.IdpollsIdthe Id of the Polls
osid.proxy.Proxyproxya proxy
Returnosid.voting.VoterAllocationAdminSessiona VoterAllocationAdminSession
ErrorsNOT_FOUNDno Polls found by the given Id
NULL_ARGUMENT pollsId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsVoterAllocationAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsVoterAllocationAdmin() and supportsVisibleFederation() are true
MethodgetVoteLookupSession
Description

Gets the OsidSession associated with the vote lookup service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.voting.VoteLookupSessiona VoteLookupSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsVoteLookup() is false
ComplianceoptionalThis method must be implemented if supportsVoteLookup() is true.
MethodgetVoteLookupSessionForPolls
Description

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

Parametersosid.id.IdpollsIdthe Id of the Polls
osid.proxy.Proxyproxya proxy
Returnosid.voting.VoteLookupSessiona VoteLookupSession
ErrorsNOT_FOUNDno Polls found by the given Id
NULL_ARGUMENT pollsId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsVoteLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsVoteLookup() and supportsVisibleFederation() are true
MethodgetVoteQuerySession
Description

Gets the OsidSession associated with the vote query service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.voting.VoteQuerySessiona VoteQuerySession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsVoteQuery() is false
ComplianceoptionalThis method must be implemented if supportsVoteQuery() is true.
MethodgetVoteQuerySessionForPolls
Description

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

Parametersosid.id.IdpollsIdthe Id of the Polls
osid.proxy.Proxyproxya proxy
Returnosid.voting.VoteQuerySessiona VoteQuerySession
ErrorsNOT_FOUNDno Polls found by the given Id
NULL_ARGUMENT pollsId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsVoteQuery() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsVoteQuery() and supportsVisibleFederation() are true
MethodgetVoteSearchSession
Description

Gets the OsidSession associated with the vote search service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.voting.VoteSearchSessiona VoteSearchSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsVoteSearch() is false
ComplianceoptionalThis method must be implemented if supportsVoteSearch() is true.
MethodgetVoteSearchSessionForPolls
Description

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

Parametersosid.id.IdpollsIdthe Id of the Polls
osid.proxy.Proxyproxya proxy
Returnosid.voting.VoteSearchSessiona VoteSearchSession
ErrorsNOT_FOUNDno polls found by the given Id
NULL_ARGUMENT pollsId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsVoteSearch() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsVoteSearch() and supportsVisibleFederation() are true
MethodgetVoteNotificationSession
Description

Gets the OsidSession associated with the vote notification service.

Parametersosid.voting.VoteReceivervoteReceiverthe notification callback
osid.proxy.Proxyproxya proxy
Returnosid.voting.VoteNotificationSessiona VoteNotificationSession
ErrorsNULL_ARGUMENT voteReceiver or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsVoteNotification() is false
ComplianceoptionalThis method must be implemented if supportsVoteNotification() is true.
MethodgetVoteNotificationSessionForPolls
Description

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

Parametersosid.voting.VoteReceivervoteReceiverthe notification callback
osid.id.IdpollsIdthe Id of the Polls
osid.proxy.Proxyproxya proxy
Returnosid.voting.VoteNotificationSessiona VoteNotificationSession
ErrorsNOT_FOUNDno polls found by the given Id
NULL_ARGUMENT voteReceiver, pollsId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsVoteNotification() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsVoteNotification() and supportsVisibleFederation() are true
MethodgetVotePollsSession
Description

Gets the session for retrieving vote to polls mappings.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.voting.VotePollsSessiona Vote PollsSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsVotePolls() is false
ComplianceoptionalThis method must be implemented if supportsVotePolls() is true.
MethodgetVotePollsAssignmentSession
Description

Gets the session for assigning votes to polls mappings.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.voting.VotePollsAssignmentSessiona VotePollsAssignmentSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsVotePollsAssignment() is false
ComplianceoptionalThis method must be implemented if supportsVotePollsAssignment() is true.
MethodgetVoteSmartPollsSession
Description

Gets the session for managing dynamic vote polls.

Parametersosid.id.IdpollsIdthe Id of the polls
osid.proxy.Proxyproxya proxy
Returnosid.voting.VoteSmartPollsSessiona VoteSmartPollsSession
ErrorsNOT_FOUND pollsId not found
NULL_ARGUMENT pollsId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsVoteSmartPolls() is false
ComplianceoptionalThis method must be implemented if supportsVoteSmartPolls() is true.
MethodgetCandidateLookupSession
Description

Gets the OsidSession associated with the candidate lookup service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.voting.CandidateLookupSession a CandidateLookupSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsCandidateLookup() is false
ComplianceoptionalThis method must be implemented if supportsCandidateLookup() is true.
MethodgetCandidateLookupSessionForPolls
Description

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

Parametersosid.id.IdpollsIdthe Id of the polls
osid.proxy.Proxyproxya proxy
Returnosid.voting.CandidateLookupSession a CandidateLookupSession
ErrorsNOT_FOUND pollsId not found
NULL_ARGUMENT pollsId or proxy is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsCandidateLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsCandidateLookup() and supportsVisibleFederation() are true.
MethodgetCandidateQuerySession
Description

Gets a candidate query session.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.voting.CandidateQuerySession a CandidateQuerySession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsCandidateQuery() is false
ComplianceoptionalThis method must be implemented if supportsCandidateQuery() is true.
MethodgetCandidateQuerySessionForPolls
Description

Gets a candidate query session for the given polls.

Parametersosid.id.IdpollsIdthe Id of the polls
osid.proxy.Proxyproxya proxy
Returnosid.voting.CandidateQuerySession a CandidateQuerySession
ErrorsNOT_FOUND pollsId not found
NULL_ARGUMENT pollsId or proxy is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsCandidateQuery() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsCandidateQuery() and supportsVisibleFederation() are true.
MethodgetCandidateSearchSession
Description

Gets a candidate search session.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.voting.CandidateSearchSession a CandidateSearchSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsCandidateSearch() is false
ComplianceoptionalThis method must be implemented if supportsCandidateSearch() is true.
MethodgetCandidateSearchSessionForPolls
Description

Gets a candidate search session for the given polls.

Parametersosid.id.IdpollsIdthe Id of the polls
osid.proxy.Proxyproxya proxy
Returnosid.voting.CandidateSearchSession a CandidateSearchSession
ErrorsNOT_FOUND pollsId not found
NULL_ARGUMENT pollsId or proxy is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsCandidateSearch() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsCandidateSearch() and supportsVisibleFederation() are true.
MethodgetCandidateAdminSession
Description

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

Parametersosid.proxy.Proxyproxya proxy
Returnosid.voting.CandidateAdminSession a CandidateAdminSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsCandidateAdmin() is false
ComplianceoptionalThis method must be implemented if supportsCandidateAdmin() is true.
MethodgetCandidateAdminSessionForPolls
Description

Gets a candidate administration session for the given polls.

Parametersosid.id.IdpollsIdthe Id of the polls
osid.proxy.Proxyproxya proxy
Returnosid.voting.CandidateAdminSession a CandidateAdminSession
ErrorsNOT_FOUND pollsId not found
NULL_ARGUMENT pollsId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsCandidateAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsCandidateAdmin() and supportsVisibleFederation() are true.
MethodgetCandidateNotificationSession
Description

Gets the notification session for notifications pertaining to candidate changes.

Parametersosid.voting.CandidateReceivercandidateReceiverthe notification callback
osid.proxy.Proxyproxya proxy
Returnosid.voting.CandidateNotificationSession a CandidateNotificationSession
ErrorsNULL_ARGUMENT candidateReceiver or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsCandidateNotification() is false
ComplianceoptionalThis method must be implemented if supportsCandidateNotification() is true.
MethodgetCandidateNotificationSessionForPolls
Description

Gets the candidate notification session for the given polls.

Parametersosid.voting.CandidateReceivercandidateReceiverthe notification callback
osid.id.IdpollsIdthe Id of the polls
osid.proxy.Proxyproxya proxy
Returnosid.voting.CandidateNotificationSession a CandidateNotificationSession
ErrorsNOT_FOUND pollsId not found
NULL_ARGUMENT candidateReceiver, pollsId or proxy is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsCandidateNotification() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsCandidateNotfication() and supportsVisibleFederation() are true.
MethodgetCandidatePollsSession
Description

Gets the session for retrieving candidate to polls mappings.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.voting.CandidatePollsSessiona CandidatePollsSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsCandidatePolls() is false
ComplianceoptionalThis method must be implemented if supportsCandidatePolls() is true.
MethodgetCandidatePollsAssignmentSession
Description

Gets the session for assigning candidate to polls mappings.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.voting.CandidatePollsAssignmentSessiona CandidatePollsAssignmentSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsCandidatePollsAssignment() is false
ComplianceoptionalThis method must be implemented if supportsCandidatePollsAssignment() is true.
MethodgetCandidateSmartPollsSession
Description

Gets the session for managing dynamic candidate polls.

Parametersosid.id.IdpollsIdthe Id of the polls
osid.proxy.Proxyproxya proxy
Returnosid.voting.CandidateSmartPollsSessiona CandidateSmartPollsSession
ErrorsNOT_FOUND pollsId not found
NULL_ARGUMENT pollsId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsCandidateSmartPolls() is false
ComplianceoptionalThis method must be implemented if supportsCandidateSmartPolls() is true.
MethodgetRaceLookupSession
Description

Gets the OsidSession associated with the race lookup service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.voting.RaceLookupSessiona RaceLookupSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsRaceLookup() is false
ComplianceoptionalThis method must be implemented if supportsRaceLookup() is true.
MethodgetRaceLookupSessionForPolls
Description

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

Parametersosid.id.IdpollsIdthe Id of the Polls
osid.proxy.Proxyproxya proxy
Returnosid.voting.RaceLookupSessiona RaceLookupSession
ErrorsNOT_FOUNDno Polls found by the given Id
NULL_ARGUMENT pollsId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsRaceLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsRaceLookup() and supportsVisibleFederation() are true
MethodgetRaceQuerySession
Description

Gets the OsidSession associated with the race query service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.voting.RaceQuerySessiona RaceQuerySession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsRaceQuery() is false
ComplianceoptionalThis method must be implemented if supportsRaceQuery() is true.
MethodgetRaceQuerySessionForPolls
Description

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

Parametersosid.id.IdpollsIdthe Id of the Polls
osid.proxy.Proxyproxya proxy
Returnosid.voting.RaceQuerySessiona RaceQuerySession
ErrorsNOT_FOUNDno Polls found by the given Id
NULL_ARGUMENT pollsId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsRaceQuery() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsRaceQuery() and supportsVisibleFederation() are true
MethodgetRaceSearchSession
Description

Gets the OsidSession associated with the race search service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.voting.RaceSearchSessiona RaceSearchSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsRaceSearch() is false
ComplianceoptionalThis method must be implemented if supportsRaceSearch() is true.
MethodgetRaceSearchSessionForPolls
Description

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

Parametersosid.id.IdpollsIdthe Id of the Polls
osid.proxy.Proxyproxya proxy
Returnosid.voting.VoteSearchSessiona RaceSearchSession
ErrorsNOT_FOUNDno polls found by the given Id
NULL_ARGUMENT pollsId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supporstRaceSearch() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsRaceSearch() and supportsVisibleFederation() are true
MethodgetRaceAdminSession
Description

Gets the OsidSession associated with the race administration service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.voting.RaceAdminSessiona RaceAdminSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsRaceAdmin() is false
ComplianceoptionalThis method must be implemented if supportsRaceAdmin() is true.
MethodgetRaceAdminSessionForPolls
Description

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

Parametersosid.id.IdpollsIdthe Id of the Polls
osid.proxy.Proxyproxya proxy
Returnosid.voting.RaceAdminSessiona RaceAdminSession
ErrorsNOT_FOUNDno polls found by the given Id
NULL_ARGUMENT pollsId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsRaceAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsRaceAdmin() and supportsVisibleFederation() are true
MethodgetRaceNotificationSession
Description

Gets the OsidSession associated with the race notification service.

Parametersosid.voting.RaceReceiverraceReceiverthe notification callback
osid.proxy.Proxyproxya proxy
Returnosid.voting.RaceNotificationSessiona RaceNotificationSession
ErrorsNULL_ARGUMENT raceReceiver or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsRaceNotification() is false
ComplianceoptionalThis method must be implemented if supportsRaceNotification() is true.
MethodgetRaceNotificationSessionForPolls
Description

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

Parametersosid.voting.RaceReceiverraceReceiverthe notification callback
osid.id.IdpollsIdthe Id of the Polls
osid.proxy.Proxyproxya proxy
Returnosid.voting.RaceNotificationSessiona RaceNotificationSession
ErrorsNOT_FOUNDno polls found by the given Id
NULL_ARGUMENT raceReceiver, pollsId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsRaceNotification() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsRaceNotification() and supportsVisibleFederation() are true
MethodgetRacePollsSession
Description

Gets the session for retrieving race to polls mappings.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.voting.RacePollsSessiona RacePollsSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsRacePolls() is false
ComplianceoptionalThis method must be implemented if supportsRacePolls() is true.
MethodgetRacePollsAssignmentSession
Description

Gets the session for assigning race to polls mappings.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.voting.RacePollsAssignmentSessiona RacePollsAssignmentSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsRacePollsAssignment() is false
ComplianceoptionalThis method must be implemented if supportsRacePollsAssignment() is true.
MethodgetRaceSmartPollsSession
Description

Gets the session for managing dynamic race polls.

Parametersosid.id.IdpollsIdthe Id of the polls
osid.proxy.Proxyproxya proxy
Returnosid.voting.RaceSmartPollsSessiona RaceSmartPollsSession
ErrorsNOT_FOUND pollsId not found
NULL_ARGUMENT pollsId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsRaceSmartPolls() is false
ComplianceoptionalThis method must be implemented if supportsRaceSmartPolls() is true.
MethodgetBallotLookupSession
Description

Gets the OsidSession associated with the ballot lookup service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.voting.BallotLookupSessiona BallotLookupSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsBallotLookup() is false
ComplianceoptionalThis method must be implemented if supportsBallotLookup() is true.
MethodgetBallotLookupSessionForPolls
Description

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

Parametersosid.id.IdpollsIdthe Id of the Polls
osid.proxy.Proxyproxya proxy
Returnosid.voting.BallotLookupSessiona BallotLookupSession
ErrorsNOT_FOUNDno Polls found by the given Id
NULL_ARGUMENT pollsId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsBallotLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsBallotLookup() and supportsVisibleFederation() are true
MethodgetBallotQuerySession
Description

Gets the OsidSession associated with the ballot query service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.voting.BallotQuerySessiona BallotQuerySession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsBallotQuery() is false
ComplianceoptionalThis method must be implemented if supportsBallotQuery() is true.
MethodgetBallotQuerySessionForPolls
Description

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

Parametersosid.id.IdpollsIdthe Id of the Polls
osid.proxy.Proxyproxya proxy
Returnosid.voting.BallotQuerySessiona BallotQuerySession
ErrorsNOT_FOUNDno Polls found by the given Id
NULL_ARGUMENT pollsId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsBallotQuery() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsBallotQuery() and supportsVisibleFederation() are true
MethodgetBallotSearchSession
Description

Gets the OsidSession associated with the ballot search service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.voting.BallotSearchSessiona RaceSearchSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsRaceSearch() is false
ComplianceoptionalThis method must be implemented if supportsBallotSearch() is true.
MethodgetBallotSearchSessionForPolls
Description

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

Parametersosid.id.IdpollsIdthe Id of the Polls
osid.proxy.Proxyproxya proxy
Returnosid.voting.BallotSearchSessiona BallotSearchSession
ErrorsNOT_FOUNDno polls found by the given Id
NULL_ARGUMENT pollsId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supporstBallotSearch() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsBallotSearch() and supportsVisibleFederation() are true
MethodgetBallotAdminSession
Description

Gets the OsidSession associated with the ballot administration service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.voting.BallotAdminSessiona BallotAdminSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsBallotAdmin() is false
ComplianceoptionalThis method must be implemented if supportsBallotAdmin() is true.
MethodgetBallotAdminSessionForPolls
Description

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

Parametersosid.id.IdpollsIdthe Id of the Polls
osid.proxy.Proxyproxya proxy
Returnosid.voting.BallotAdminSessiona BallotAdminSession
ErrorsNOT_FOUNDno polls found by the given Id
NULL_ARGUMENT pollsId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsBallotAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsBallotAdmin() and supportsVisibleFederation() are true
MethodgetBallotNotificationSession
Description

Gets the OsidSession associated with the ballot notification service.

Parametersosid.voting.BallotReceiverballotReceiverthe notification callback
osid.proxy.Proxyproxya proxy
Returnosid.voting.BallotNotificationSessiona BallotNotificationSession
ErrorsNULL_ARGUMENT ballotReceiver or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsBallotNotification() is false
ComplianceoptionalThis method must be implemented if supportsBallotNotification() is true.
MethodgetBallotNotificationSessionForPolls
Description

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

Parametersosid.voting.BallotReceiverballotReceiverthe notification callback
osid.id.IdpollsIdthe Id of the Polls
osid.proxy.Proxyproxya proxy
Returnosid.voting.BallotNotificationSessiona BallotNotificationSession
ErrorsNOT_FOUNDno polls found by the given Id
NULL_ARGUMENT ballotReceiver, pollsId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsBallotNotification() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsBallotNotification() and supportsVisibleFederation() are true
MethodgetBallotPollsSession
Description

Gets the session for retrieving ballot to polls mappings.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.voting.BallotPollsSessiona BallotPollsSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsBallotPolls() is false
ComplianceoptionalThis method must be implemented if supportsBallotPolls() is true.
MethodgetBallotPollsAssignmentSession
Description

Gets the session for assigning ballot to polls mappings.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.voting.BallotPollsAssignmentSessiona BallotPollsAssignmentSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsBallotPollsAssignment() is false
ComplianceoptionalThis method must be implemented if supportsBallotPollsAssignment() is true.
MethodgetBallotSmartPollsSession
Description

Gets the session for managing dynamic ballot polls.

Parametersosid.id.IdpollsIdthe Id of the polls
osid.proxy.Proxyproxya proxy
Returnosid.voting.BallotSmartPollsSessiona BallotSmartPollsSession
ErrorsNOT_FOUND pollsId not found
NULL_ARGUMENT pollsId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsBallotSmartPolls() is false
ComplianceoptionalThis method must be implemented if supportsBallotSmartPolls() is true.
MethodgetPollsLookupSession
Description

Gets the polls lookup session.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.voting.PollsLookupSessiona PollsLookupSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPollsLookup() is false
ComplianceoptionalThis method must be implemented if supportsPollsLookup() is true.
MethodgetPollsQuerySession
Description

Gets the polls query session.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.voting.PollsQuerySessiona PollsQuerySession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPollsQuery() is false
ComplianceoptionalThis method must be implemented if supportsPollsQuery() is true.
MethodgetPollsSearchSession
Description

Gets the polls search session.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.voting.PollsSearchSessiona PollsSearchSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPollsSearch() is false
ComplianceoptionalThis method must be implemented if supportsPollsSearch() is true.
MethodgetPollsAdminSession
Description

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

Parametersosid.proxy.Proxyproxya proxy
Returnosid.voting.PollsAdminSessiona PollsAdminSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPollsAdmin() is false
ComplianceoptionalThis method must be implemented if supportsPollsAdmin() is true.
MethodgetPollsNotificationSession
Description

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

Parametersosid.voting.PollsReceiverpollsReceiverthe notification callback
osid.proxy.Proxyproxya proxy
Returnosid.voting.PollsNotificationSessiona PollsNotificationSession
ErrorsNULL_ARGUMENT pollsReceiver or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPollsNotification() is false
ComplianceoptionalThis method must be implemented if supportsPollsNotification() is true.
MethodgetPollsHierarchySession
Description

Gets the polls hierarchy traversal session.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.voting.PollsHierarchySession a PollsHierarchySession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPollsHierarchy() is false
ComplianceoptionalThis method must be implemented if supportsPollsHierarchy() is true.
MethodgetPollsHierarchyDesignSession
Description

Gets the polls hierarchy design session.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.voting.PollsHierarchyDesignSessiona PollsHierarchyDesignSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPollsHierarchyDesign() is false
ComplianceoptionalThis method must be implemented if supportsPollsHierarchyDesign() is true.
MethodgetVotingBatchProxyManager
Description

Gets a VotingBatchProxyManager.

Returnosid.voting.batch.VotingBatchProxyManagera VotingBatchProxyManager
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsVotingBatch() is false
ComplianceoptionalThis method must be implemented if supportsVotingBatch() is true.
MethodgetVotingRulesProxyManager
Description

Gets a VotingRulesProxyManager.

Returnosid.voting.rules.VotingRulesProxyManagera VotingRulesProxyManager
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsVotingRules() is false
ComplianceoptionalThis method must be implemented if supportsVotingRules() is true.