org.osid.cataloging

Interface CatalogList

All Superinterfaces:

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

public interface CatalogList
extends OsidList

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

       
       
       while (cl.hasNext()) {
            Catalog catalog = cl.getNextCatalog();
       }
       
                   
       
  

or

       
       
       while (cl.hasNext()) {
            Catalog[] catalogs = cl.getNextCatalogs(cl.available());
       }
       
                   
       
  

Method Summary

Methods

Modifier and Type	Method and Description
Catalog	getNextCatalog() Gets the next Catalog in this list.
Catalog[]	getNextCatalogs(long n) Gets the next set of Catalog 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

getNextCatalog

Catalog getNextCatalog()
                       throws OperationFailedException

Gets the next Catalog in this list.

Returns:

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

getNextCatalogs

Catalog[] getNextCatalogs(long n)
                          throws OperationFailedException

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

Parameters:

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

Returns:

an array of Catalog 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.