org.osid.billing

Interface CategoryList

All Superinterfaces:

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

public interface CategoryList
extends OsidList

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

       
       
       while (cl.hasNext()) {
            Category category = cl.getNextCategory();
       }
       
                   
       
  

or

       
       
       while (cl.hasNext()) {
            Category[] categories = cl.getNextCategories(cl.available());
       }
       
                   
       
  

Method Summary

Methods

Modifier and Type	Method and Description
Category[]	getNextCategories(long n) Gets the next set of Category elements in this list.
Category	getNextCategory() Gets the next Category in this list.

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

getNextCategory

Category getNextCategory()
                         throws OperationFailedException

Gets the next Category in this list.

Returns:

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

getNextCategories

Category[] getNextCategories(long n)
                             throws OperationFailedException

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

Parameters:

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

Returns:

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