OSID Logo
OSID Specifications
ordering package
Version 3.1.0
Interfaceosid.ordering.StoreNodeList
Implementsosid.OsidList
Used Byosid.ordering.StoreNode
Description

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

while (snl.hasNext()) {
     StoreNode node = snl.getNextStoreNode();
}
                
or
while (snl.hasNext()) {
     StoreNode[] nodes = snl.getNextStoreNodes(snl.available());
}
                
MethodgetNextStoreNode
Description

Gets the next StoreNode in this list.

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

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

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