org.osid.course

Interface ActivityUnitList

All Superinterfaces:

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

public interface ActivityUnitList
extends OsidList

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

       
       
       while (aul.hasNext()) {
            ActivityUnit unit = aul.getNextActivityUnit();
       }
       
                   
       
  

or

       
       
       while (aul.hasNext()) {
            ActivityUnit[] units = aul.getNextActivityUnits(aul.available());
       }
       
                   
       
  

Method Summary

Methods

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

getNextActivityUnit

ActivityUnit getNextActivityUnit()
                                 throws OperationFailedException

Gets the next ActivityUnit in this list.

Returns:

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

getNextActivityUnits

ActivityUnit[] getNextActivityUnits(long n)
                                    throws OperationFailedException

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

Parameters:

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

Returns:

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