org.osid.acknowledgement

Interface CreditList

All Superinterfaces:

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

public interface CreditList
extends OsidList

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

       
       
       while (cl.hasNext()) {
            Credit credit = cl.getNextCredit();
       }
       
                   
       
  

or

       
       
       while (cl.hasNext()) {
            Credit[] credits = cl.getNextCredits(cl.available());
       }
       
                   
       
  

Method Summary

Methods

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

getNextCredit

Credit getNextCredit()
                     throws OperationFailedException

Gets the next Credit in this list.

Returns:

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

getNextCredits

Credit[] getNextCredits(long n)
                        throws OperationFailedException

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

Parameters:

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

Returns:

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