OSID - osid.voting.CandidateList Service Interface Definition

Interface	osid.voting.CandidateList
Implements	`osid.OsidList`
Used By	`osid.voting.CandidateLookupSession`
	`osid.voting.CandidatePollsSession`
	`osid.voting.CandidateQuerySession`
	`osid.voting.CandidateSearchResults`
Description	Like all `OsidLists`, `CandidateList` provides a means for accessing `Candidate` elements sequentially either one at a time or many at a time. Examples: while (cl.hasNext()) { Candidate candidate = cl.getNextCandidate(); } or while (cl.hasNext()) { Candidate[] candidates = cl.getNextCandidates(cl.available()); }
Method	getNextCandidate
Description	Gets the next `Candidate` in this list.
Return	`osid.voting.Candidate`		the next `Candidate` in this list. The `hasNext()` method should be used to test that a next `Candidate` is available before calling this method.
Errors	ILLEGAL_STATE		no more elements available in this list
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	getNextCandidates
Description	Gets the next set of `Candidates` in this list which must be less than or equal to the return from `available()`.
Parameters	`cardinal`	`n`	the number of `Candidate` elements requested which must be less than or equal to `available()`
Return	`osid.voting.Candidate[]`		an array of `Candidate` elements. The length of the array is less than or equal to the number specified.
Errors	ILLEGAL_STATE		no more elements available in this list
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.