org.osid.assessment.authoring

Interface SequenceRuleList

All Superinterfaces:

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

public interface SequenceRuleList
extends OsidList

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

       
       
       while (srl.hasNext()) {
            AssessmentSequenceRule rule = srl.getNextAssessmentSequenceRule();
       }
       
                   
       
  

or

       
       
       while (srl.hasNext()) {
            AssessmentSequenceRule[] rules = srl.getNextAssessmentSequenceRules(srl.available());
       }
       
                   
       
  

Method Summary

Methods

Modifier and Type	Method and Description
SequenceRule	getNextSequenceRule() Gets the next SequenceRule in this list.
SequenceRule[]	getNextSequenceRules(long n) Gets the next set of SequenceRule elements in this list which must be less than or equal to the number returned from available().

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

getNextSequenceRule

SequenceRule getNextSequenceRule()
                                 throws OperationFailedException

Gets the next SequenceRule in this list.

Returns:

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

getNextSequenceRules

SequenceRule[] getNextSequenceRules(long n)
                                    throws OperationFailedException

Gets the next set of SequenceRule elements in this list which must be less than or equal to the number returned from available().

Parameters:

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

Returns:

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