org.osid.logging

Interface LogEntryList

All Superinterfaces:

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

public interface LogEntryList
extends OsidList

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

       
       
       while (lel.hasNext()) {
            LogEntry entry = lel.getNextLogEntry();
       }
       
                   
       
  

or

       
       
       while (lel.hasNext()) {
            LogEntry[] entries = lel.getNextLogEntries(lel.available());
       }
       
                   
       
  

Method Summary

Methods

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

getNextLogEntry

LogEntry getNextLogEntry()
                         throws OperationFailedException

Gets the next LogEntry in this list.

Returns:

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

getNextLogEntries

LogEntry[] getNextLogEntries(long n)
                             throws OperationFailedException

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

Parameters:

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

Returns:

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