| Interface | osid.voting.VotingManager | ||
|---|---|---|---|
| Implements | osid.OsidManager | ||
osid.voting.VotingProfile | |||
| Description | 
                 The voring manager provides access to voting sessions and provides interoperability tests for various aspects of this service. The sessions included in this manager are: 
 
 
 
 
  | ||
| Method | getVotingSession | ||
| Description | 
                     Gets the   | ||
| Return | osid.voting.VotingSession | a  VotingSession   | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED |  supportsVoting()  is  false   |                 ||
| Compliance | optional | This method must be implemented if  supportsVoting()  is 
 true.   | |
| Method | getVotingSessionForPolls | ||
| Description | 
                     Gets the   | ||
| Parameters | osid.id.Id | pollsId | the  Id  of the  Pools   | 
| Return | osid.voting.VotingSession | a  VotingSession   | |
| Errors | NOT_FOUND | no  Polls  found by the given  Id   |                 |
| NULL_ARGUMENT |  pollsId  is  null   |                 ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED |  supportsVoting()  or  supportsVisibleFederation() 
 is  false   |                 ||
| Compliance | optional | This method must be implemented if  supportsVoting()  and 
 supportsVisibleFederation()  are  true   | |
| Method | getRaceResultsSession | ||
| Description | 
                     Gets the   | ||
| Return | osid.voting.RaceResultsSession | a  RaceResultsSession   | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED |  supportsRaceResults()  is  false   |                 ||
| Compliance | optional | This method must be implemented if  supportsRaceResults()  is 
 true.   | |
| Method | getRaceResultsSessionForPolls | ||
| Description | 
                     Gets the   | ||
| Parameters | osid.id.Id | pollsId | the  Id  of the  Pools   | 
| Return | osid.voting.RaceResultsSession | a  RaceResultsSession   | |
| Errors | NOT_FOUND | no  Polls  found by the given  Id   |                 |
| NULL_ARGUMENT |  pollsId  is  null   |                 ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED |  supportsRaceResults()  or  supportsVisibleFederation() 
 is  false   |                 ||
| Compliance | optional | This method must be implemented if  supportsRaceResults()  and 
 supportsVisibleFederation()  are  true   | |
| Method | getVoterAllocationLookupSession | ||
| Description | 
                     Gets the   | ||
| Return | osid.voting.VoterAllocationLookupSession | a  VoterAllocationLookupSession   | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED |  supportsVoterAllocationLookup()  is  false   |                 ||
| Compliance | optional | This method must be implemented if  supportsVoterAllocationLookup() 
 is  true.   | |
| Method | getVoterAllocationLookupSessionForPolls | ||
| Description | 
                     Gets the   | ||
| Parameters | osid.id.Id | pollsId | the  Id  of the  Polls   | 
| Return | osid.voting.VoterAllocationLookupSession | a  VoterAllocationLookupSession   | |
| Errors | NOT_FOUND | no  Polls  found by the given Id  |                 |
| NULL_ARGUMENT |  pollsId  is  null   |                 ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED |  supportsVoterAllocationLookup()  or  
supportsVisibleFederation()  is  false   |                 ||
| Compliance | optional | This method must be implemented if  supportsVoterAllocationLookup() 
 and  supportsVisibleFederation()  are  true   | |
| Method | getVoterAllocationAdminSession | ||
| Description | 
                     Gets the   | ||
| Return | osid.voting.VoterAllocationAdminSession | a  VoterAllocationAdminSession   | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED |  supportsVoterAllocationAdmin()  is  false   |                 ||
| Compliance | optional | This method must be implemented if  supportsVoterAllocationAdmin() 
 is  true.   | |
| Method | getVoterAllocationAdminSessionForPolls | ||
| Description | 
                     Gets the   | ||
| Parameters | osid.id.Id | pollsId | the  Id  of the  Polls   | 
| Return | osid.voting.VoterAllocationAdminSession | a  VoterAllocationAdminSession   | |
| Errors | NOT_FOUND | no  Polls  found by the given Id  |                 |
| NULL_ARGUMENT |  pollsId  is  null   |                 ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED |  supportsVoterAllocationAdmin()  or  
supportsVisibleFederation()  is  false   |                 ||
| Compliance | optional | This method must be implemented if  supportsVoterAllocationAdmin() 
 and  supportsVisibleFederation()  are  true   | |
| Method | getVoteLookupSession | ||
| Description | 
                     Gets the   | ||
| Return | osid.voting.VoteLookupSession | a  VoteLookupSession   | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED |  supportsVoteLookup()  is  false   |                 ||
| Compliance | optional | This method must be implemented if  supportsVoteLookup()  is 
 true.   | |
| Method | getVoteLookupSessionForPolls | ||
| Description | 
                     Gets the   | ||
| Parameters | osid.id.Id | pollsId | the  Id  of the  Polls   | 
| Return | osid.voting.VoteLookupSession | a  VoteLookupSession   | |
| Errors | NOT_FOUND | no  Polls  found by the given  Id   |                 |
| NULL_ARGUMENT |  pollsId  is  null   |                 ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED |  supportsVoteLookup()  or  supportsVisibleFederation() 
 is  false   |                 ||
| Compliance | optional | This method must be implemented if  supportsVoteLookup()  and 
 supportsVisibleFederation()  are  true   | |
| Method | getVoteQuerySession | ||
| Description | 
                     Gets the   | ||
| Return | osid.voting.VoteQuerySession | a  VoteQuerySession   | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED |  supportsVoteQuery()  is  false   |                 ||
| Compliance | optional | This method must be implemented if  supportsVoteQuery()  is 
 true.   | |
| Method | getVoteQuerySessionForPolls | ||
| Description | 
                     Gets the   | ||
| Parameters | osid.id.Id | pollsId | the  Id  of the  Polls   | 
| Return | osid.voting.VoteQuerySession | a  VoteQuerySession   | |
| Errors | NOT_FOUND | no  Polls  found by the given  Id   |                 |
| NULL_ARGUMENT |  pollsId  is  null   |                 ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED |  supportsVoteQuery()  or  supportsVisibleFederation() 
 is  false   |                 ||
| Compliance | optional | This method must be implemented if  supportsVoteQuery()  and 
 supportsVisibleFederation()  are  true   | |
| Method | getVoteSearchSession | ||
| Description | 
                     Gets the   | ||
| Return | osid.voting.VoteSearchSession | a  VoteSearchSession   | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED |  supportsVoteSearch()  is  false   |                 ||
| Compliance | optional | This method must be implemented if  supportsVoteSearch()  is 
 true.   | |
| Method | getVoteSearchSessionForPolls | ||
| Description | 
                     Gets the   | ||
| Parameters | osid.id.Id | pollsId | the  Id  of the  Polls   | 
| Return | osid.voting.VoteSearchSession | a  VoteSearchSession   | |
| Errors | NOT_FOUND | no polls found by the given  Id   |                 |
| NULL_ARGUMENT |  pollsId  is  null   |                 ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED |  supportsVoteSearch()  or  supportsVisibleFederation() 
 is  false   |                 ||
| Compliance | optional | This method must be implemented if  supportsVoteSearch()  and 
 supportsVisibleFederation()  are  true   | |
| Method | getVoteNotificationSession | ||
| Description | 
                     Gets the   | ||
| Parameters | osid.voting.VoteReceiver | voteReceiver | the notification callback | 
| Return | osid.voting.VoteNotificationSession | a  VoteNotificationSession   | |
| Errors | NULL_ARGUMENT |  voteReceiver  is  null   |                 |
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED |  supportsVoteNotification()  is  false   |                 ||
| Compliance | optional | This method must be implemented if  supportsVoteNotification() 
 is  true.   | |
| Method | getVoteNotificationSessionForPolls | ||
| Description | 
                     Gets the   | ||
| Parameters | osid.voting.VoteReceiver | voteReceiver | the notification callback | 
osid.id.Id | pollsId | the  Id  of the  Polls   | |
| Return | osid.voting.VoteNotificationSession | a  VoteNotificationSession   | |
| Errors | NOT_FOUND | no polls found by the given  Id   |                 |
| NULL_ARGUMENT |  voteReceiver  or  pollsId  is  null 
  |                 ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED |  supportsVoteNotification()  or  
supportsVisibleFederation()  is  false   |                 ||
| Compliance | optional | This method must be implemented if  supportsVoteNotification() 
 and  supportsVisibleFederation()  are  true   | |
| Method | getVotePollsSession | ||
| Description | 
                     Gets the session for retrieving vote to polls mappings.  | ||
| Return | osid.voting.VotePollsSession | a  VotePollsSession   | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED |  supportsVotePolls()  is  false   |                 ||
| Compliance | optional | This method must be implemented if  supportsVotePolls()  is 
 true.   | |
| Method | getVotePollsAssignmentSession | ||
| Description | 
                     Gets the session for assigning votes to polls mappings.  | ||
| Return | osid.voting.VotePollsAssignmentSession | a  VotePollsAssignmentSession   | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED |  supportsVotePollsAssignment()  is  false   |                 ||
| Compliance | optional | This method must be implemented if  supportsVotePollsAssignment() 
 is  true.   | |
| Method | getVoteSmartPollsSession | ||
| Description | 
                     Gets the session for managing dynamic vote polls.  | ||
| Parameters | osid.id.Id | pollsId | the  Id  of the polls  | 
| Return | osid.voting.VoteSmartPollsSession | a  VoteSmartPollsSession   | |
| Errors | NOT_FOUND |  pollsId  not found  |                 |
| NULL_ARGUMENT |  pollsId  is  null   |                 ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED |  supportsVoteSmartPolls()  is  false   |                 ||
| Compliance | optional | This method must be implemented if  supportsVoteSmartPolls()  
is  true.   | |
| Method | getCandidateLookupSession | ||
| Description | 
                     Gets the   | ||
| Return | osid.voting.CandidateLookupSession |  a CandidateLookupSession   | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED |  supportsCandidateLookup()  is  false   |                 ||
| Compliance | optional | This method must be implemented if  supportsCandidateLookup()  
is  true.   | |
| Method | getCandidateLookupSessionForPolls | ||
| Description | 
                     Gets the   | ||
| Parameters | osid.id.Id | pollsId | the  Id  of the polls  | 
| Return | osid.voting.CandidateLookupSession |  a CandidateLookupSession   | |
| Errors | NOT_FOUND |  pollsId  not found  |                 |
| NULL_ARGUMENT |  pollsId  is  null   |                 ||
| OPERATION_FAILED |  unable to complete request   |                 ||
| UNIMPLEMENTED |  supportsCandidateLookup()  or  
supportsVisibleFederation()  is  false   |                 ||
| Compliance | optional | This method must be implemented if  supportsCandidateLookup()  
and  supportsVisibleFederation()  are  true.   | |
| Method | getCandidateQuerySession | ||
| Description | 
                     Gets a candidate query session.  | ||
| Return | osid.voting.CandidateQuerySession |  a CandidateQuerySession   | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED |  supportsCandidateQuery()  is  false   |                 ||
| Compliance | optional | This method must be implemented if  supportsCandidateQuery()  
is  true.   | |
| Method | getCandidateQuerySessionForPolls | ||
| Description | 
                     Gets a candidate query session for the given polls.  | ||
| Parameters | osid.id.Id | pollsId | the  Id  of the polls  | 
| Return | osid.voting.CandidateQuerySession |  a CandidateQuerySession   | |
| Errors | NOT_FOUND |  pollsId  not found  |                 |
| NULL_ARGUMENT |  pollsId  is  null   |                 ||
| OPERATION_FAILED |  unable to complete request   |                 ||
| UNIMPLEMENTED |  supportsCandidateQuery()  or  
supportsVisibleFederation()  is  false   |                 ||
| Compliance | optional | This method must be implemented if  supportsCandidateQuery()  
and  supportsVisibleFederation()  are  true.   | |
| Method | getCandidateSearchSession | ||
| Description | 
                     Gets a candidate search session.  | ||
| Return | osid.voting.CandidateSearchSession |  a CandidateSearchSession   | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED |  supportsCandidateSearch()  is  false   |                 ||
| Compliance | optional | This method must be implemented if  supportsCandidateSearch()  
is  true.   | |
| Method | getCandidateSearchSessionForPolls | ||
| Description | 
                     Gets a candidate search session for the given polls.  | ||
| Parameters | osid.id.Id | pollsId | the  Id  of the polls  | 
| Return | osid.voting.CandidateSearchSession |  a CandidateSearchSession   | |
| Errors | NOT_FOUND |  pollsId  not found  |                 |
| NULL_ARGUMENT |  pollsId  is  null   |                 ||
| OPERATION_FAILED |  unable to complete request   |                 ||
| UNIMPLEMENTED |  supportsCandidateSearch()  or  
supportsVisibleFederation()  is  false   |                 ||
| Compliance | optional | This method must be implemented if  supportsCandidateSearch()  
and  supportsVisibleFederation()  are  true.   | |
| Method | getCandidateAdminSession | ||
| Description | 
                     Gets a candidate administration session for creating, updating and deleting candidates.  | ||
| Return | osid.voting.CandidateAdminSession |  a CandidateAdminSession   | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED |  supportsCandidateAdmin()  is  false   |                 ||
| Compliance | optional | This method must be implemented if  supportsCandidateAdmin()  
is  true.   | |
| Method | getCandidateAdminSessionForPolls | ||
| Description | 
                     Gets a candidate administration session for the given polls.  | ||
| Parameters | osid.id.Id | pollsId | the  Id  of the polls  | 
| Return | osid.voting.CandidateAdminSession |  a CandidateAdminSession   | |
| Errors | NOT_FOUND |  pollsId  not found  |                 |
| NULL_ARGUMENT |  pollsId  is  null   |                 ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED |  supportsCandidateAdmin()  or  
supportsVisibleFederation()  is  false   |                 ||
| Compliance | optional | This method must be implemented if  supportsCandidateAdmin()  
and  supportsVisibleFederation()  are  true.   | |
| Method | getCandidateNotificationSession | ||
| Description | 
                     Gets the notification session for notifications pertaining to candidate changes.  | ||
| Parameters | osid.voting.CandidateReceiver | candidateReceiver | the notification callback | 
| Return | osid.voting.CandidateNotificationSession |  a CandidateNotificationSession   | |
| Errors | NULL_ARGUMENT |  candidateReceiver  is  null   |                 |
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED |  supportsCandidateNotification()  is  false   |                 ||
| Compliance | optional | This method must be implemented if  supportsCandidateNotification() 
 is  true.   | |
| Method | getCandidateNotificationSessionForPolls | ||
| Description | 
                     Gets the candidate notification session for the given polls.  | ||
| Parameters | osid.voting.CandidateReceiver | candidateReceiver | the notification callback | 
osid.id.Id | pollsId | the  Id  of the polls  | |
| Return | osid.voting.CandidateNotificationSession |  a CandidateNotificationSession   | |
| Errors | NOT_FOUND |  pollsId  not found  |                 |
| NULL_ARGUMENT |  candidateReceiver  or  pollsId  is  null 
  |                 ||
| OPERATION_FAILED |  unable to complete request   |                 ||
| UNIMPLEMENTED |  supportsCandidateNotification()  or  
supportsVisibleFederation()  is  false   |                 ||
| Compliance | optional | This method must be implemented if  supportsCandidateNotfication() 
 and  supportsVisibleFederation()  are  true. 
  | |
| Method | getCandidatePollsSession | ||
| Description | 
                     Gets the session for retrieving candidate to polls mappings.  | ||
| Return | osid.voting.CandidatePollsSession | a  CandidatePollsSession   | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED |  supportsCandidatePolls()  is  false   |                 ||
| Compliance | optional | This method must be implemented if  supportsCandidatePolls()  
is  true.   | |
| Method | getCandidatePollsAssignmentSession | ||
| Description | 
                     Gets the session for assigning candidate to polls mappings.  | ||
| Return | osid.voting.CandidatePollsAssignmentSession | a  CandidatePollsAssignmentSession   | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED |  supportsCandidatePollsAssignment()  is  false   |                 ||
| Compliance | optional | This method must be implemented if  
supportsCandidatePollsAssignment()  is  true.   | |
| Method | getCandidateSmartPollsSession | ||
| Description | 
                     Gets the session for managing dynamic candidate polls.  | ||
| Parameters | osid.id.Id | pollsId | the  Id  of the polls  | 
| Return | osid.voting.CandidateSmartPollsSession | a  CandidateSmartPollsSession   | |
| Errors | NOT_FOUND |  pollsId  not found  |                 |
| NULL_ARGUMENT |  pollsId  is  null   |                 ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED |  supportsCandidateSmartPolls()  is  false   |                 ||
| Compliance | optional | This method must be implemented if  supportsCandidateSmartPolls() 
 is  true.   | |
| Method | getRaceLookupSession | ||
| Description | 
                     Gets the   | ||
| Return | osid.voting.RaceLookupSession | a  RaceLookupSession   | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED |  supportsRaceLookup()  is  false   |                 ||
| Compliance | optional | This method must be implemented if  supportsRaceLookup()  is 
 true.   | |
| Method | getRaceLookupSessionForPolls | ||
| Description | 
                     Gets the   | ||
| Parameters | osid.id.Id | pollsId | the  Id  of the  Polls   | 
| Return | osid.voting.RaceLookupSession | a  RaceLookupSession   | |
| Errors | NOT_FOUND | no  Polls  found by the given  Id   |                 |
| NULL_ARGUMENT |  pollsId  is  null   |                 ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED |  supportsRaceLookup()  or  supportsVisibleFederation() 
 is  false   |                 ||
| Compliance | optional | This method must be implemented if  supportsRaceLookup()  and 
 supportsVisibleFederation()  are  true   | |
| Method | getRaceQuerySession | ||
| Description | 
                     Gets the   | ||
| Return | osid.voting.RaceQuerySession | a  RaceQuerySession   | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED |  supportsRaceQuery()  is  false   |                 ||
| Compliance | optional | This method must be implemented if  supportsRaceQuery()  is 
 true.   | |
| Method | getRaceQuerySessionForPolls | ||
| Description | 
                     Gets the   | ||
| Parameters | osid.id.Id | pollsId | the  Id  of the  Polls   | 
| Return | osid.voting.RaceQuerySession | a  RaceQuerySession   | |
| Errors | NOT_FOUND | no  Polls  found by the given  Id   |                 |
| NULL_ARGUMENT |  pollsId  is  null   |                 ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED |  supportsRaceQuery()  or  supportsVisibleFederation() 
 is  false   |                 ||
| Compliance | optional | This method must be implemented if  supportsRaceQuery()  and 
 supportsVisibleFederation()  are  true   | |
| Method | getRaceSearchSession | ||
| Description | 
                     Gets the   | ||
| Return | osid.voting.RaceSearchSession | a  RaceSearchSession   | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED |  supportsRaceSearch()  is  false   |                 ||
| Compliance | optional | This method must be implemented if  supportsRaceSearch()  is 
 true.   | |
| Method | getRaceSearchSessionForPolls | ||
| Description | 
                     Gets the   | ||
| Parameters | osid.id.Id | pollsId | the  Id  of the  Polls   | 
| Return | osid.voting.VoteSearchSession | a  RaceSearchSession   | |
| Errors | NOT_FOUND | no polls found by the given  Id   |                 |
| NULL_ARGUMENT |  pollsId  is  null   |                 ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED |  supporstRaceSearch()  or  supportsVisibleFederation() 
 is  false   |                 ||
| Compliance | optional | This method must be implemented if  supportsRaceSearch()  and 
 supportsVisibleFederation()  are  true   | |
| Method | getRaceAdminSession | ||
| Description | 
                     Gets the   | ||
| Return | osid.voting.RaceAdminSession | a  RaceAdminSession   | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED |  supportsRaceAdmin()  is  false   |                 ||
| Compliance | optional | This method must be implemented if  supportsRaceAdmin()  is 
 true.   | |
| Method | getRaceAdminSessionForPolls | ||
| Description | 
                     Gets the   | ||
| Parameters | osid.id.Id | pollsId | the  Id  of the  Polls   | 
| Return | osid.voting.RaceAdminSession | a  RaceAdminSession   | |
| Errors | NOT_FOUND | no polls found by the given  Id   |                 |
| NULL_ARGUMENT |  pollsId  is  null   |                 ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED |  supportsRaceAdmin()  or  supportsVisibleFederation() 
 is  false   |                 ||
| Compliance | optional | This method must be implemented if  supportsRaceAdmin()  and 
 supportsVisibleFederation()  are  true   | |
| Method | getRaceNotificationSession | ||
| Description | 
                     Gets the   | ||
| Parameters | osid.voting.RaceReceiver | raceReceiver | the notification callback | 
| Return | osid.voting.RaceNotificationSession | a  RaceNotificationSession   | |
| Errors | NULL_ARGUMENT |  raceReceiver  is  null   |                 |
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED |  supportsRaceNotification()  is  false   |                 ||
| Compliance | optional | This method must be implemented if  supportsRaceNotification() 
 is  true.   | |
| Method | getRaceNotificationSessionForPolls | ||
| Description | 
                     Gets the   | ||
| Parameters | osid.voting.RaceReceiver | raceReceiver | the notification callback | 
osid.id.Id | pollsId | the  Id  of the  Polls   | |
| Return | osid.voting.RaceNotificationSession | a  RaceNotificationSession   | |
| Errors | NOT_FOUND | no polls found by the given  Id   |                 |
| NULL_ARGUMENT |  raceReceiver  or  pollsId  is  null 
  |                 ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED |  supportsRaceNotification()  or  
supportsVisibleFederation()  is  false   |                 ||
| Compliance | optional | This method must be implemented if  supportsRaceNotification() 
 and  supportsVisibleFederation()  are  true   | |
| Method | getRacePollsSession | ||
| Description | 
                     Gets the session for retrieving race to polls mappings.  | ||
| Return | osid.voting.RacePollsSession | a  RacePollsSession   | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED |  supportsRacePolls()  is  false   |                 ||
| Compliance | optional | This method must be implemented if  supportsRacePolls()  is 
 true.   | |
| Method | getRacePollsAssignmentSession | ||
| Description | 
                     Gets the session for assigning race to polls mappings.  | ||
| Return | osid.voting.RacePollsAssignmentSession | a  RacePollsAssignmentSession   | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED |  supportsRacePollsAssignment()  is  false   |                 ||
| Compliance | optional | This method must be implemented if  supportsRacePollsAssignment() 
 is  true.   | |
| Method | getRaceSmartPollsSession | ||
| Description | 
                     Gets the session for managing dynamic race polls.  | ||
| Parameters | osid.id.Id | pollsId | the  Id  of the polls  | 
| Return | osid.voting.RaceSmartPollsSession | a  RaceSmartPollsSession   | |
| Errors | NOT_FOUND |  pollsId  not found  |                 |
| NULL_ARGUMENT |  pollsId  is  null   |                 ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED |  supportsRaceSmartPolls()  is  false   |                 ||
| Compliance | optional | This method must be implemented if  supportsRaceSmartPolls()  
is  true.   | |
| Method | getBallotLookupSession | ||
| Description | 
                     Gets the   | ||
| Return | osid.voting.BallotLookupSession | a  BallotLookupSession   | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED |  supportsBallotLookup()  is  false   |                 ||
| Compliance | optional | This method must be implemented if  supportsBallotLookup()  is 
 true.   | |
| Method | getBallotLookupSessionForPolls | ||
| Description | 
                     Gets the   | ||
| Parameters | osid.id.Id | pollsId | the  Id  of the  Polls   | 
| Return | osid.voting.BallotLookupSession | a  BallotLookupSession   | |
| Errors | NOT_FOUND | no  Polls  found by the given  Id   |                 |
| NULL_ARGUMENT |  pollsId  is  null   |                 ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED |  supportsBallotLookup()  or  supportsVisibleFederation() 
 is  false   |                 ||
| Compliance | optional | This method must be implemented if  supportsBallotLookup()  
and  supportsVisibleFederation()  are  true   | |
| Method | getBallotQuerySession | ||
| Description | 
                     Gets the   | ||
| Return | osid.voting.BallotQuerySession | a  BallotQuerySession   | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED |  supportsBallotQuery()  is  false   |                 ||
| Compliance | optional | This method must be implemented if  supportsBallotQuery()  is 
 true.   | |
| Method | getBallotQuerySessionForPolls | ||
| Description | 
                     Gets the   | ||
| Parameters | osid.id.Id | pollsId | the  Id  of the  Polls   | 
| Return | osid.voting.BallotQuerySession | a  BallotQuerySession   | |
| Errors | NOT_FOUND | no  Polls  found by the given  Id   |                 |
| NULL_ARGUMENT |  pollsId  is  null   |                 ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED |  supportsBallotQuery()  or  supportsVisibleFederation() 
 is  false   |                 ||
| Compliance | optional | This method must be implemented if  supportsBallotQuery()  and 
 supportsVisibleFederation()  are  true   | |
| Method | getBallotSearchSession | ||
| Description | 
                     Gets the   | ||
| Return | osid.voting.BallotSearchSession | a  RaceSearchSession   | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED |  supportsRaceSearch()  is  false   |                 ||
| Compliance | optional | This method must be implemented if  supportsBallotSearch()  is 
 true.   | |
| Method | getBallotSearchSessionForPolls | ||
| Description | 
                     Gets the   | ||
| Parameters | osid.id.Id | pollsId | the  Id  of the  Polls   | 
| Return | osid.voting.BallotSearchSession | a  BallotSearchSession   | |
| Errors | NOT_FOUND | no polls found by the given  Id   |                 |
| NULL_ARGUMENT |  pollsId  is  null   |                 ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED |  supporstBallotSearch()  or  supportsVisibleFederation() 
 is  false   |                 ||
| Compliance | optional | This method must be implemented if  supportsBallotSearch()  
and  supportsVisibleFederation()  are  true   | |
| Method | getBallotAdminSession | ||
| Description | 
                     Gets the   | ||
| Return | osid.voting.BallotAdminSession | a  BallotAdminSession   | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED |  supportsBallotAdmin()  is  false   |                 ||
| Compliance | optional | This method must be implemented if  supportsBallotAdmin()  is 
 true.   | |
| Method | getBallotAdminSessionForPolls | ||
| Description | 
                     Gets the   | ||
| Parameters | osid.id.Id | pollsId | the  Id  of the  Polls   | 
| Return | osid.voting.BallotAdminSession | a  BallotAdminSession   | |
| Errors | NOT_FOUND | no polls found by the given  Id   |                 |
| NULL_ARGUMENT |  pollsId  is  null   |                 ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED |  supportsBallotAdmin()  or  supportsVisibleFederation() 
 is  false   |                 ||
| Compliance | optional | This method must be implemented if  supportsBallotAdmin()  and 
 supportsVisibleFederation()  are  true   | |
| Method | getBallotNotificationSession | ||
| Description | 
                     Gets the   | ||
| Parameters | osid.voting.BallotReceiver | ballotReceiver | the notification callback | 
| Return | osid.voting.BallotNotificationSession | a  BallotNotificationSession   | |
| Errors | NULL_ARGUMENT |  ballotReceiver  is  null   |                 |
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED |  supportsBallotNotification()  is  false   |                 ||
| Compliance | optional | This method must be implemented if  supportsBallotNotification() 
 is  true.   | |
| Method | getBallotNotificationSessionForPolls | ||
| Description | 
                     Gets the   | ||
| Parameters | osid.voting.BallotReceiver | ballotReceiver | the notification callback | 
osid.id.Id | pollsId | the  Id  of the  Polls   | |
| Return | osid.voting.BallotNotificationSession | a  BallotNotificationSession   | |
| Errors | NOT_FOUND | no polls found by the given  Id   |                 |
| NULL_ARGUMENT |  ballotReceiver  or  pollsId  is  null 
  |                 ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED |  supportsBallotNotification()  or  
supportsVisibleFederation()  is  false   |                 ||
| Compliance | optional | This method must be implemented if  supportsBallotNotification() 
 and  supportsVisibleFederation()  are  true   | |
| Method | getBallotPollsSession | ||
| Description | 
                     Gets the session for retrieving ballot to polls mappings.  | ||
| Return | osid.voting.BallotPollsSession | a  BallotPollsSession   | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED |  supportsBallotPolls()  is  false   |                 ||
| Compliance | optional | This method must be implemented if  supportsBallotPolls()  is 
 true.   | |
| Method | getBallotPollsAssignmentSession | ||
| Description | 
                     Gets the session for assigning ballot to polls mappings.  | ||
| Return | osid.voting.BallotPollsAssignmentSession | a  BallotPollsAssignmentSession   | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED |  supportsBallotPollsAssignment()  is  false   |                 ||
| Compliance | optional | This method must be implemented if  supportsBallotPollsAssignment() 
 is  true.   | |
| Method | getBallotSmartPollsSession | ||
| Description | 
                     Gets the session for managing dynamic ballot polls.  | ||
| Parameters | osid.id.Id | pollsId | the  Id  of the polls  | 
| Return | osid.voting.BallotSmartPollsSession | a  BallotSmartPollsSession   | |
| Errors | NOT_FOUND |  pollsId  not found  |                 |
| NULL_ARGUMENT |  pollsId  is  null   |                 ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED |  supportsBallotSmartPolls()  is  false   |                 ||
| Compliance | optional | This method must be implemented if  supportsBallotSmartPolls() 
 is  true.   | |
| Method | getPollsLookupSession | ||
| Description | 
                     Gets the polls lookup session.  | ||
| Return | osid.voting.PollsLookupSession | a  PollsLookupSession   | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED |  supportsPollsLookup()  is  false   |                 ||
| Compliance | optional | This method must be implemented if  supportsPollsLookup()  is 
 true.   | |
| Method | getPollsQuerySession | ||
| Description | 
                     Gets the polls query session.  | ||
| Return | osid.voting.PollsQuerySession | a  PollsQuerySession   | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED |  supportsPollsQuery()  is  false   |                 ||
| Compliance | optional | This method must be implemented if  supportsPollsQuery()  is 
 true.   | |
| Method | getPollsSearchSession | ||
| Description | 
                     Gets the polls search session.  | ||
| Return | osid.voting.PollsSearchSession | a  PollsSearchSession   | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED |  supportsPollsSearch()  is  false   |                 ||
| Compliance | optional | This method must be implemented if  supportsPollsSearch()  is 
 true.   | |
| Method | getPollsAdminSession | ||
| Description | 
                     Gets the polls administrative session for creating, updating and deleteing polls.  | ||
| Return | osid.voting.PollsAdminSession | a  PollsAdminSession   | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED |  supportsPollsAdmin()  is  false   |                 ||
| Compliance | optional | This method must be implemented if  supportsPollsAdmin()  is 
 true.   | |
| Method | getPollsNotificationSession | ||
| Description | 
                     Gets the notification session for subscripollsg to changes to a polls.  | ||
| Parameters | osid.voting.PollsReceiver | pollsReceiver | the notification callback | 
| Return | osid.voting.PollsNotificationSession | a  PollsNotificationSession   | |
| Errors | NULL_ARGUMENT |  pollsReceiver  is  null   |                 |
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED |  supportsPollsNotification()  is  false   |                 ||
| Compliance | optional | This method must be implemented if  supportsPollsNotification() 
 is  true.   | |
| Method | getPollsHierarchySession | ||
| Description | 
                     Gets the polls hierarchy traversal session.  | ||
| Return | osid.voting.PollsHierarchySession |  a PollsHierarchySession   | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED |  supportsPollsHierarchy()  is  false   |                 ||
| Compliance | optional | This method must be implemented if  supportsPollsHierarchy()  
is  true.   | |
| Method | getPollsHierarchyDesignSession | ||
| Description | 
                     Gets the polls hierarchy design session.  | ||
| Return | osid.voting.PollsHierarchyDesignSession | a  PollsHierarchyDesignSession   | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED |  supportsPollsHierarchyDesign()  is  false   |                 ||
| Compliance | optional | This method must be implemented if  supportsPollsHierarchyDesign() 
 is  true.   | |
| Method | getVotingBatchManager | ||
| Description | 
                     Gets a   | ||
| Return | osid.voting.batch.VotingBatchManager | a  VotingBatchManager   | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED |  supportsVotingBatch()  is  false   |                 ||
| Compliance | optional | This method must be implemented if  supportsVotingBatch()  is 
 true.   | |
| Method | getVotingRulesManager | ||
| Description | 
                     Gets a   | ||
| Return | osid.voting.rules.VotingRulesManager | a  VotingRulesManager   | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED |  supportsVotingRules()  is  false   |                 ||
| Compliance | optional | This method must be implemented if  supportsVotingRules()  is 
 true.   | |