Interface AwardList

All Superinterfaces:

AutoCloseable, Closeable, OsidList, OsidList

public interface AwardList
extends OsidList

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

while (al.hasNext()) {
     Award award = al.getNextAward();
}            
  

or

while (al.hasNext()) {
     Award[] awards = al.getNextAwards(al.available());
}            
  

Method Summary

Modifier and Type	Method	Description
Award	getNextAward()	Gets the next Award in this list.
Award[]	getNextAwards(long n)	Gets the next set of Award elements in this list.

Methods inherited from interface Closeable

close

Methods inherited from interface OsidList

close

Modifier and Type	Method	Description
void	close()	Close this list.

Methods inherited from interface OsidList

available, hasNext, skip

Modifier and Type	Method	Description
long	available()	Gets the number of elements available for retrieval.
boolean	hasNext()	Tests if there are more elements in this list.
void	skip(long n)	Skip the specified number of elements in the list.

Method Details

getNextAward

Award getNextAward()
            throws OperationFailedException

Gets the next Award in this list.

Returns:

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

getNextAwards

Award[] getNextAwards(long n)
               throws OperationFailedException

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

Parameters:

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

Returns:

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