Interface CandidateList

All Superinterfaces:
AutoCloseable, Closeable, OsidList, OsidList
public interface CandidateList extends OsidList

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 Summary

    Modifier and Type
    Method
    Description
    Candidate
    getNextCandidate()
    Gets the next Candidate in this list.
    Candidate[]
    getNextCandidates(long n)
    Gets the next set of Candidates in this list which must be less than or equal to the return from available() .

    Methods inherited from interface Closeable

    close

    Methods inherited from interface OsidList

    close
    Modifier and Type
    Method
    Description
    void
    close()
    Close this list.

    Methods inherited from interface OsidList

    available, hasNext, skip
    Modifier and Type
    Method
    Description
    long
    available()
    Gets the number of elements available for retrieval.
    boolean
    hasNext()
    Tests if there are more elements in this list.
    void
    skip(long n)
    Skip the specified number of elements in the list.

  • Method Details

    • getNextCandidate

      Candidate getNextCandidate() throws OperationFailedException
      Gets the next Candidate in this list.
      Returns:
      the next Candidate in this list. The hasNext() method should be used to test that a next Candidate is available before calling this method.
      Throws:
      IllegalStateException - no more elements available in this list
      OperationFailedException - unable to complete request
      Compliance:
      mandatory - This method must be implemented.

    • getNextCandidates

      Candidate[] getNextCandidates(long n) throws OperationFailedException
      Gets the next set of Candidates in this list which must be less than or equal to the return from available() .
      Parameters:
      n - the number of Candidate elements requested which must be less than or equal to available()
      Returns:
      an array of Candidate elements. The length of the array is less than or equal to the number specified.
      Throws:
      IllegalStateException - no more elements available in this list
      OperationFailedException - unable to complete request
      Compliance:
      mandatory - This method must be implemented.