Interface | osid.voting.CandidateList | ||
---|---|---|---|
Implements | osid.OsidList | ||
Description |
Like all while (cl.hasNext()) { Candidate candidate = cl.getNextCandidate(); }or while (cl.hasNext()) { Candidate[] candidates = cl.getNextCandidates(cl.available()); } | ||
Method | getNextCandidate | ||
Description |
Gets the next | ||
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 | |
OPERATION_FAILED | unable to complete request | ||
Compliance | mandatory | This method must be implemented. | |
Method | getNextCandidates | ||
Description |
Gets the next set of | ||
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 | |
OPERATION_FAILED | unable to complete request | ||
Compliance | mandatory | This method must be implemented. |