OSID Logo
OSID Specifications
voting rules package
Version 3.1.0
Interfaceosid.voting.rules.VoteEnablerList
Implementsosid.OsidList
Used Byosid.voting.rules.VoteEnablerLookupSession
osid.voting.rules.VoteEnablerPollsSession
osid.voting.rules.VoteEnablerQuerySession
osid.voting.rules.VoteEnablerRuleLookupSession
osid.voting.rules.VoteEnablerSearchResults
Description

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

while (vel.hasNext()) {
     VoteEnabler enabler = vel.getNextVoteEnabler();
}

or

while (vel.hasNext()) {
     VoteEnabler[] enablers = vel.getNextVoteEnablers(vel.available());
}
                
MethodgetNextVoteEnabler
Description

Gets the next VoteEnabler in this list.

Returnosid.voting.rules.VoteEnabler the next VoteEnabler in this list. The hasNext() method should be used to test that a next VoteEnabler is available before calling this method.
ErrorsILLEGAL_STATE no more elements available in this list
OPERATION_FAILED unable to complete request
Compliancemandatory This method must be implemented.
MethodgetNextVoteEnablers
Description

Gets the next set of VoteEnabler elements in this list. The specified amount must be less than or equal to the return from available().

Parameterscardinaln the number of VoteEnabler elements requested which must be less than or equal to available()
Returnosid.voting.rules.VoteEnabler[] an array of VoteEnabler elements. The length of the array is less than or equal to the number specified.
ErrorsILLEGAL_STATE no more elements available in this list
OPERATION_FAILED unable to complete request
Compliancemandatory This method must be implemented.