org.osid.sequencing

Interface ChainList

All Superinterfaces:

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

public interface ChainList
extends OsidList

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

       
       
       while (cl.hasNext()) {
            Chain chain = cl.getNextChain();
       }
       
                   
       
  

or

       
       
       while (cl.hasNext()) {
            Chain[] chains = cl.getNextChains(cl.available());
       }
       
                   
       
  

Method Summary

Methods

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

getNextChain

Chain getNextChain()
                   throws OperationFailedException

Gets the next Chain in this list.

Returns:

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

getNextChains

Chain[] getNextChains(long n)
                      throws OperationFailedException

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

Parameters:

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

Returns:

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