org.osid.inquiry

Interface AuditList

All Superinterfaces:

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

public interface AuditList
extends OsidList

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

       
       
       while (al.hasNext()) {
            Audit audit = al.getNextAudit();
       }
       
                   
       
  

or

       
       
       while (al.hasNext()) {
            Audit[] audits = al.getNextAudits(al.available());
       }
       
                   
       
  

Method Summary

Methods

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

getNextAudit

Audit getNextAudit()
                   throws OperationFailedException

Gets the next Audit in this list.

Returns:

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

getNextAudits

Audit[] getNextAudits(long n)
                      throws OperationFailedException

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

Parameters:

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

Returns:

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