org.osid.journaling.batch

Interface JournalEntryPeerList

All Superinterfaces:

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

public interface JournalEntryPeerList
extends OsidList

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

       
       
       while (jepl.hasNext()) {
            JournalEntryPeer peer = jepl.getNextJournalEntryPeer();
       }
       
                   
       
  

or

       
       
       while (jepl.hasNext()) {
            JournalEntryPeer[] peers = jepl.getNextJournalEntryPeers(jepl.available());
       }
       
                   
       
  

Method Summary

Methods

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

getNextJournalEntryPeer

JournalEntryPeer getNextJournalEntryPeer()
                                         throws OperationFailedException

Gets the next JournalEntryPeer in this list.

Returns:

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

getNextJournalEntryPeers

JournalEntryPeer[] getNextJournalEntryPeers(long n)
                                            throws OperationFailedException

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

Parameters:

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

Returns:

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