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

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

                     
                     
                     while (pnl.hasNext()) {
                          PollsNode node = pnl.getNextPollsNode();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (pnl.hasNext()) {
                          PollsNode[] nodes = pnl.getNextPollsNodes(pnl.available());
                     }
                     
                                 
                     
                
MethodgetNextPollsNode
Description

Gets the next PollsNode in this list.

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

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

Parameterscardinalnthe number of PollsNode elements requested which must be less than or equal to available()
Returnosid.voting.PollsNode[]an array of PollsNode 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.