Interface GradeSystemTransformList

All Superinterfaces:

AutoCloseable, Closeable, OsidList, OsidList

public interface GradeSystemTransformList
extends OsidList

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

while (gstl.hasNext()) {
     GradeSystemTransform transform = gtsl.getNextGradeSystemTransform();
}            
  

or

while (gstl.hasNext()) {
     GradeSystemTransform[] transforms = gstl.getNextGradeSystemTransforms(gstl.available());
}            
  

Method Summary

Modifier and Type	Method	Description
GradeSystemTransform	getNextGradeSystemTransform()	Gets the next GradeSystemTransform in this list.
GradeSystemTransform[]	getNextGradeSystemTransforms(long n)	Gets the next set of GradeSystemTransform elements in this list which must be less than or equal to the return from available() .

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

getNextGradeSystemTransform

GradeSystemTransform getNextGradeSystemTransform()
                                          throws OperationFailedException

Gets the next GradeSystemTransform in this list.

Returns:

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

getNextGradeSystemTransforms

GradeSystemTransform[] getNextGradeSystemTransforms(long n)
                                             throws OperationFailedException

Gets the next set of GradeSystemTransform elements in this list which must be less than or equal to the return from available() .

Parameters:

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

Returns:

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