OSID Logo
OSID Specifications
financials posting package
Version 3.0.0
Release Candidate Preview
Interfaceosid.financials.posting.PostEntryList
Implementsosid.OsidList
Description

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

                     
                     
                     while (pel.hasNext()) {
                          PostEntry post entry = pel.getNextPostEntry();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (pel.hasNext()) {
                          PostEntry[] entries = pel.getNextPostEntries(pel.available());
                     }
                     
                                 
                     
                
MethodgetNextPostEntry
Description

Gets the next PostEntry in this list.

Returnosid.financials.posting.PostEntrythe next PostEntry in this list. The hasNext() method should be used to test that a next PostEntry is available before calling this method.
ErrorsILLEGAL_STATEno more elements available in this list
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetNextPostEntries
Description

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

Parameterscardinalnthe number of PostEntry elements requested which must be less than or equal to available()
Returnosid.financials.posting.PostEntry[]an array of PostEntry 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.