org.osid.cataloging

Interface CatalogNodeList

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidList

public interface CatalogNodeList
extends OsidList

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

       
       
       while (cnl.hasNext()) {
            CatalogNode node = cnl.getNextCatalogNode();
       }
       
                   
       
  

or

       
       
       while (cnl.hasNext()) {
            CatalogNode[] nodes = cnl.getNextCatalogNodes(cnl.available());
       }
       
                   
       
  

Method Summary

Methods

Modifier and Type	Method and Description
CatalogNode	getNextCatalogNode() Gets the next CatalogNode in this list.
CatalogNode[]	getNextCatalogNodes(long n) Gets the next set of CatalogNode elements in this list which must be less than or equal to the number returned from available().

Methods inherited from interface org.osid.OsidList

available, hasNext, skip

Methods inherited from interface org.osid.binding.java.OsidList

close

Methods inherited from interface java.io.Closeable

close

Method Detail

getNextCatalogNode

CatalogNode getNextCatalogNode()
                               throws OperationFailedException

Gets the next CatalogNode in this list.

Returns:

the next CatalogNode in this list. The hasNext() method should be used to test that a next CatalogNode is available before calling this method.

Throws:

IllegalStateException - no more elements available in this list

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

getNextCatalogNodes

CatalogNode[] getNextCatalogNodes(long n)
                                  throws OperationFailedException

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

Parameters:

n - the number of CatalogNode elements requested which should be less than or equal to available()

Returns:

an array of CatalogNode elements. The length of the array is less than or equal to the number specified.

Throws:

IllegalStateException - no more elements available in this list

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.