OSID Logo
OSID Specifications
voting package
Version 3.0.0
Release Candidate Preview
Interfaceosid.voting.VoterAllocationList
Implementsosid.OsidList
Description

Like all OsidLists, VoterAllocationList provides a means for accessing VoterAllocation elements sequentially either one at a time or many at a time. Examples:

                     
                     
                     while (val.hasNext()) {
                          VoterAllocation allocation = val.getNextVoterAllocation();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (val.hasNext()) {
                          Vote[] allocations = val.getNextVoterAllocations(val.available());
                     }
                     
                                 
                     
                
MethodgetNextVoterAllocation
Description

Gets the next VoterAllocation in this list.

Returnosid.voting.VoterAllocationthe next VoterAllocation in this list. The hasNext() method should be used to test that a next VoterAllocation is available before calling this method.
ErrorsILLEGAL_STATEno more elements available in this list
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetNextVoterAllocations
Description

Gets the next set of VoterAllocation elements in this list which must be less than or equal to the number returned from available().

Parameterscardinalnthe number of VoterAllocation elements requested which should be less than or equal to available()
Returnosid.voting.VoterAllocation[]an array of VoterAllocation elements. The length of the array is less than or equal to the number specified.
ErrorsILLEGAL_STATEno more elements available in this list
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.