org.osid.course.plan

Interface LessonAnchorList

All Superinterfaces:

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

public interface LessonAnchorList
extends OsidList

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

       
       
       while (lal.hasNext()) {
            LessonAnchor anchor = lal.getNextLessonAnchor();
       }
       
                   
       
  

or

       
       
       while (lal.hasNext()) {
            LessonAnchor[] anchors = lal.getNextLessonAnchors(lal.available());
       }
       
                   
       
  

Method Summary

Methods

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

getNextLessonAnchor

LessonAnchor getNextLessonAnchor()
                                 throws OperationFailedException

Gets the next LessonAnchor in this list.

Returns:

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

getNextLessonAnchors

LessonAnchor[] getNextLessonAnchors(long n)
                                    throws OperationFailedException

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

Parameters:

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

Returns:

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