OSID Logo
OSID Specifications
financials budgeting batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.financials.budgeting.batch.BudgetPeerList
Implementsosid.OsidList
Description

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

                     
                     
                     while bpl.hasNext()) {
                          BudgetPeer peer = bfl.getNextBudgetPeer();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (bpl.hasNext()) {
                          BudgetPeer[] peers = bpl.getNextBudgetPeers(bpl.available());
                     }
                     
                                 
                     
                
MethodgetNextBudgetPeer
Description

Gets the next BudgetPeer in this list.

Returnosid.financials.budgeting.batch.BudgetPeerthe next BudgetPeer in this list. The hasNext() method should be used to test that a next BudgetPeer is available before calling this method.
ErrorsILLEGAL_STATEno more elements available in this list
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetNextBudgetPeers
Description

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

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