org.osid.rules.check

Interface CheckResultList

All Superinterfaces:

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

public interface CheckResultList
extends OsidList

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

       
       
       while (crl.hasNext()) {
            CheckResult result = crl.getNextCheckResult();
       }
       
                   
       
  

or

       
       
       while (crl.hasNext()) {
            CheckResult[] results = crl.getNextCheckResults(crl.available());
       }
       
                   
       
  

Method Summary

Methods

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

getNextCheckResult

CheckResult getNextCheckResult()
                               throws OperationFailedException

Gets the next CheckResult in this list.

Returns:

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

getNextCheckResults

CheckResult[] getNextCheckResults(long n)
                                  throws OperationFailedException

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

Parameters:

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

Returns:

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