OSID Logo
OSID Specifications
lexicon package
Version 3.1.0
Interfaceosid.lexicon.PressNodeList
Implementsosid.OsidList
Used Byosid.lexicon.PressNode
Description

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

while (pnl.hasNext()) {
     PressNode node = pnl.getNextPressNode();
}
                
or
while (pnl.hasNext()) {
     PressNode[] nodes = pnl.getNextPressNodes(pnl.available());
}
                
MethodgetNextPressNode
Description

Gets the next PressNode in this list.

Returnosid.lexicon.PressNode the next PressNode in this list. The hasNext() method should be used to test that a next PressNode 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.
MethodgetNextPressNodes
Description

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

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