org.osid.billing

Interface EntryList

All Superinterfaces:

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

public interface EntryList
extends OsidList

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

       
       
       while (el.hasNext()) {
            Entry entry = el.getNextEntry();
       }
       
                   
       
  

or

       
       
       while (el.hasNext()) {
            Entry[] entries = el.getNextEntries(el.available());
       }
       
                   
       
  

Method Summary

Methods

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

getNextEntry

Entry getNextEntry()
                   throws OperationFailedException

Gets the next Entry in this list.

Returns:

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

getNextEntries

Entry[] getNextEntries(long n)
                       throws OperationFailedException

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

Parameters:

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

Returns:

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