OSID Logo
OSID Specifications
financials budgeting batch package
Version 3.1.0
Interfaceosid.financials.budgeting.batch.BudgetEntryPeerList
Implementsosid.OsidList
Description

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

while bepl.hasNext()) {
     BudgetEntryPeer peer = bepl.getNextBudgetEntryPeer();
}
                
or
while (bepl.hasNext()) {
     BudgetEntryPeer[] peers = bepl.getNextBudgetEntryPeers(bepl.available());
}
                
MethodgetNextBudgetEntryPeer
Description

Gets the next BudgetEntryPeer in this list.

Returnosid.financials.budgeting.batch.BudgetEntryPeer the next BudgetEntryPeer in this list. The hasNext() method should be used to test that a next BudgetEntryPeer is available before calling this method.
ErrorsILLEGAL_STATE no more elements available in this list
OPERATION_FAILED unable to complete request
Compliancemandatory This method must be implemented.
MethodgetNextBudgetEntryPeers
Description

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

Parameterscardinaln the number of BudgetEntryPeer elements requested which must be less than or equal to available()
Returnosid.financials.budgeting.batch.BudgetEntryPeer[] an array of BudgetEntryPeer elements. The length of the array is less than or equal to the number specified.
ErrorsILLEGAL_STATE no more elements available in this list
OPERATION_FAILED unable to complete request
Compliancemandatory This method must be implemented.