OSID Logo
OSID Specifications
offering package
Version 3.1.0
Interfaceosid.offering.CatalogueNodeList
Implementsosid.OsidList
Used Byosid.offering.CatalogueNode
Description

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

while (rnl.hasNext()) {
     CatalogueNode node = rnl.getNextCatalogueNode();
}
                
or
while (rnl.hasNext()) {
     CatalogueNode[] nodes = rnl.getNextCatalogueNodes(rnl.available());
}
                
MethodgetNextCatalogueNode
Description

Gets the next CatalogueNode in this list.

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

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

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