org.osid.billing

Interface ItemList

All Superinterfaces:

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

public interface ItemList
extends OsidList

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

       
       
       while (il.hasNext()) {
            Item unit = il.getNextItem();
       }
       
                   
       
  

or

       
       
       while (il.hasNext()) {
            Item[] units = il.getNextItems(il.available());
       }
       
                   
       
  

Method Summary

Methods

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

getNextItem

Item getNextItem()
                 throws OperationFailedException

Gets the next Item in this list.

Returns:

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

getNextItems

Item[] getNextItems(long n)
                    throws OperationFailedException

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

Parameters:

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

Returns:

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