Interface StepList

All Superinterfaces:

AutoCloseable, Closeable, OsidList, OsidList

public interface StepList
extends OsidList

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

while (sl.hasNext()) {
     Step step = sl.getNextStep();
}            
  

or

while (sl.hasNext()) {
     Step[] steps = sl.getNextSteps(sl.available());
}            
  

Method Summary

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

getNextStep

Step getNextStep()
          throws OperationFailedException

Gets the next Step in this list.

Returns:

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

getNextSteps

Step[] getNextSteps(long n)
             throws OperationFailedException

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

Parameters:

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

Returns:

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