org.osid.voting

Interface Summary
Interface	Description
Ballot	A `Ballot` represents a set of races.
BallotAdminSession	This session creates, updates, and deletes `Ballots.`
BallotAuthoringSession	This session provides methods for authoring ballots.
BallotForm	This is the form for creating and updating `Ballots.`
BallotList	Like all `OsidLists,` `BallotList` provides a means for accessing `Ballot` elements sequentially either one at a time or many at a time.
BallotLookupSession	This session defines methods for retrieving ballots.
BallotNotificationSession	This session defines methods to receive notifications on adds/changes to `Ballot` objects in this `Polls.`
BallotPollsAssignmentSession	This session provides methods to re-assign `Ballots` to `Polls.`
BallotPollsSession	This session provides methods to retrieve `Ballot` to `Polls` mappings.
BallotQuery	This is the query for searching ballots.
BallotQueryInspector	This is the query inspector for examining ballot queries.
BallotQuerySession	This session provides methods for searching among `Ballot` objects.
BallotReceiver	The candidate receiver is the consumer supplied interface for receiving notifications pertaining to new, updated or deleted `Ballot` objects.
BallotSearch	The search interface for governing ballot searches.
BallotSearchOrder	An interface for specifying the ordering of search results.
BallotSearchResults	This interface provides a means to capture results of a search.
BallotSearchSession	This session provides methods for searching among `Ballot` objects.
BallotSmartPollsSession	This session manages queries and sequencing to create "smart" dynamic catalogs.
Candidate	A `Candidate` represents a voting option in a race.
CandidateAdminSession	This session creates, updates, and deletes `Candidates.`
CandidateForm	This is the form for creating and updating `Candidates.`
CandidateList	Like all `OsidLists,` `CandidateList` provides a means for accessing `Candidate` elements sequentially either one at a time or many at a time.
CandidateLookupSession	This session defines methods for retrieving candidates.
CandidateNotificationSession	This session defines methods to receive notifications on adds/changes to `Candidate` objects in this `Polls.`
CandidatePollsAssignmentSession	This session provides methods to re-assign `Candidates` to `Polls.`
CandidatePollsSession	This session provides methods to retrieve `Candidate` to `Polls` mappings.
CandidateQuery	This is the query for searching candidates.
CandidateQueryInspector	This is the query inspector for examining candidate queries.
CandidateQuerySession	This session provides methods for searching among `Candidate` objects.
CandidateReceiver	The candidate receiver is the consumer supplied interface for receiving notifications pertaining to new, updated or deleted `Candidate` objects.
CandidateSearch	The search interface for governing candidate searches.
CandidateSearchOrder	An interface for specifying the ordering of search results.
CandidateSearchResults	This interface provides a means to capture results of a search.
CandidateSearchSession	This session provides methods for searching among `Candidate` objects.
CandidateSmartPollsSession	This session manages queries and sequencing to create "smart" dynamic catalogs.
Polls	An inventory defines a collection of candidates.
PollsAdminSession	This session creates, updates, and deletes `Polls.`
PollsForm	This is the form for creating and updating polls.
PollsHierarchyDesignSession	This session defines methods for managing a hierarchy of `Polls` objects.
PollsHierarchySession	This session defines methods for traversing a hierarchy of `Polls` objects.
PollsList	Like all `OsidLists,` `PollsList` provides a means for accessing `Polls` elements sequentially either one at a time or many at a time.
PollsLookupSession	This session provides methods for retrieving `Polls` objects.
PollsNode	This interface is a container for a partial hierarchy retrieval.
PollsNodeList	Like all `OsidLists,` `PollsNodeList` provides a means for accessing `PollsNode` elements sequentially either one at a time or many at a time.
PollsNotificationSession	This session defines methods to receive notifications on adds/changes to `Polls` objects.
PollsQuery	This is the query for searching polls.
PollsQueryInspector	This is the query inspector for examining poll queries.
PollsQuerySession	This session provides methods for searching among `Polls` objects.
PollsReceiver	The polls receiver is the consumer supplied interface for receiving notifications pertaining to new, updated or deleted `Polls` objects.
PollsSearch	The interface for governing polls searches.
PollsSearchOrder	An interface for specifying the ordering of search results.
PollsSearchResults	This interface provides a means to capture results of a search.
PollsSearchSession	This session provides methods for searching among `Polls` objects.
Race	An `Race` defines a competition among `Candidates.`
RaceAdminSession	This session creates, updates, and deletes `Races.`
RaceForm	This is the form for creating and updating races.
RaceList	Like all `OsidLists,` `RaceList` provides a means for accessing `Race` elements sequentially either one at a time or many at a time.
RaceLookupSession	This session defines methods for retrieving races.
RaceNotificationSession	This session defines methods to receive notifications on new or deleted races.
RacePollsAssignmentSession	This session provides methods to re-assign `Races` to `Polls` objects A `Race` may appear in multiple `Polls` objects and removing the last reference to a `Race` is the equivalent of deleting it.
RacePollsSession	This session provides methods to retrieve `Race` to `Polls` mappings.
RaceQuery	This is the query for searching races.
RaceQueryInspector	This is the query inspector for examining race queries.
RaceQuerySession	This session provides methods for searching among races.
RaceReceiver	The race receiver is the consumer supplied interface for receiving notifications pertaining to new, updated or deleted `Race` objects.
RaceResult	The results for a candidate in a race.
RaceResultList	Like all `OsidLists,` `RaceResultsList` provides a means for accessing `RaceResults` elements sequentially either one at a time or many at a time.
RaceResultsSession	This session provides methods for examining voting results.
RaceSearch	The search interface for governing race searches.
RaceSearchOrder	An interface for specifying the ordering of search results.
RaceSearchResults	This interface provides a means to capture results of a search.
RaceSearchSession	This session provides methods for searching among races.
RaceSmartPollsSession	This session manages queries and sequencing to create "smart" dynamic catalogs.
Vote	A `Vote` is a relationship between a `Candidate` and a `voter.`
VoteForm	This is the form for creating and updating `Votes.`
VoteList	Like all `OsidLists,` `VoteList` provides a means for accessing `Vote` elements sequentially either one at a time or many at a time.
VoteLookupSession	This session provides methods for looking up votes.
VoteNotificationSession	This session defines methods to receive asynchronous notifications on adds/changes to votes.
VotePollsAssignmentSession	This session provides methods to re-assign `Votes` to `Polls.`
VotePollsSession	This session provides methods to retrieve `Vote` to `Polls` mappings.
VoteQuery	This is the query for searching votes.
VoteQueryInspector	This is the query inspector for examining vote queries.
VoteQuerySession	This session provides methods for searching `Vote` objects.
VoterAllocation	An allocation of votes for an individual resource or a resource group.
VoterAllocationAdminSession	This session manages voter allocations.
VoterAllocationForm	This is the form for creating and updating `VoterAllocations.`
VoterAllocationList	Like all `OsidLists,` `VoterAllocationList` provides a means for accessing `VoterAllocation` elements sequentially either one at a time or many at a time.
VoterAllocationLookupSession	This session provides methods for looking up voter allocations.
VoteReceiver	The vote receiver is the consumer supplied interface for receiving notifications pertaining to new, updated or deleted `Votes.`
VoteSearch	`VoteSearch` defines the interface for specifying vote search options.
VoteSearchOrder	An interface for specifying the ordering of search results.
VoteSearchResults	This interface provides a means to capture results of a search.
VoteSearchSession	This session provides methods for searching `Vote` objects.
VoteSmartPollsSession	This session manages queries and sequencing to create "smart" dynamic catalogs.
VotingManager	The voring manager provides access to voting sessions and provides interoperability tests for various aspects of this service.
VotingProfile	The voting profile describes interoperability among voting services.
VotingProxyManager	The candidate manager provides access to candidate lookup and creation session and provides interoperability tests for various aspects of this service.
VotingSession	This session provides methods for voting on a ballot.

Package org.osid.voting Description

The Open Service Interface Definitions for the org.osid.voting service.

The Voting OSID defines a means of holding elections.

Ballots

Ballots are the central OsidGovernator for the Voting OSID. Ballots are the focal point for a set of rules that govern the operation of an election. Ballots are also Temporal where voting occurs within a fixed period of time. The Voting OSID makes available Ballots which are active (open for voting), Ballots of past elections, and Ballots representing scheduled elections in the future.

Races

Ballots are composed of Races. A Race aggregates a set of Candidates. Races are constrained to a single Ballot but are also OsidGovernators to encapsulate the rules governing a specific race.

Candidates

A Candidate is something to vote for in a Race on a Ballot. A Candidate is an OsidRelationship between a Resource and a Race.

Votes

A Vote is cast by a voter for a Candidate. A Vote is an OsidRelationship between the voter and a Candidate . Some Ballots may permit multiple votes to be cast for a Candidate. A VoterAllocation manages these limits.

Polls Cataloging

Ballots, Races, Candidates, and Votes may be organized into federateable Poll catalogs.

Sub Packages

The Voting OSID includes a Voting Rules OSID for managing the constraints and processing of Ballots and Races in an election. It also contains a Voting Batch OSID for bulk administration.

This Work is being provided by the copyright holder(s) subject to the following license. By obtaining, using and/or copying this Work, you agree that you have read, understand, and will comply with the following terms and conditions.

Permission to use, copy and distribute unmodified versions of this Work, for any purpose, without fee or royalty is hereby granted, provided that you include the above copyright notices and the terms of this license on ALL copies of the Work or portions thereof.

You may modify or create Derivatives of this Work only for your internal purposes. You shall not distribute or transfer any such Derivative of this Work to any location or to any third party. For the purposes of this license, "Derivative" shall mean any derivative of the Work as defined in the United States Copyright Act of 1976, such as a translation or modification.

This Work and the information contained herein is provided on an "AS IS" basis WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE WORK OR THE USE OR OTHER DEALINGS IN THE WORK.

The export of software employing encryption technology may require a specific license from the United States Government. It is the responsibility of any person or organization contemplating export to obtain such a license before exporting this Work.