OSID Logo
OSID Specifications
journaling package
Version 3.0.0
Release Candidate Preview
Interfaceosid.journaling.JournalNodeList
Implementsosid.OsidList
Description

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

                     
                     
                     while (jnl.hasNext()) {
                          JournalNode node = jnl.getNextJournalNode();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (jnl.hasNext()) {
                          JournalNode[] nodes = jnl.getNextJournalNodes(jnl.available());
                     }
                     
                                 
                     
                
MethodgetNextJournalNode
Description

Gets the next JournalNode in this list.

Returnosid.journaling.JournalNodethe next JournalNode in this list. The hasNext() method should be used to test that a next JournalNode is available before calling this method.
ErrorsILLEGAL_STATEno more elements available in this list
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetNextJournalNodes
Description

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

Parameterscardinalnthe number of JournalNode elements requested which must be less than or equal to available()
Returnosid.journaling.JournalNode[]an array of JournalNode elements. The length of the array is less than or equal to the number specified.
ErrorsILLEGAL_STATEno more elements available in this list
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.