org.osid.course

Interface ActivityList

All Superinterfaces:

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

public interface ActivityList
extends OsidList

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

       
       
       while (al.hasNext()) {
            Activity activity = al.getNextActivity();
       }
       
                   
       
  

or

       
       
       while (al.hasNext()) {
            Activity[] activities = al.getNextActivities(al.available());
       }
       
                   
       
  

Method Summary

Methods

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

getNextActivity

Activity getNextActivity()
                         throws OperationFailedException

Gets the next Activity in this list.

Returns:

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

getNextActivities

Activity[] getNextActivities(long n)
                             throws OperationFailedException

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

Parameters:

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

Returns:

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