org.osid.journaling

Interface JournalList

All Superinterfaces:

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

public interface JournalList
extends OsidList

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

       
       
       while (jl.hasNext()) {
            Journal journal = jl.getNextJournal();
       }
       
                   
       
  

or

       
       
       while (jl.hasNext()) {
            Journal[] journal = jl.getNextJournals(jl.available());
       }
       
                   
       
  

Method Summary

Methods

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

getNextJournal

Journal getNextJournal()
                       throws OperationFailedException

Gets the next Journal in this list.

Returns:

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

getNextJournals

Journal[] getNextJournals(long n)
                          throws OperationFailedException

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

Parameters:

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

Returns:

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