OSID Logo
OSID Specifications
acknowledgement batch package
Version 3.1.0
Interfaceosid.acknowledgement.batch.CreditPeerList
Implementsosid.OsidList
Description

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

while (cpl.hasNext()) {
     CreditPeer peer = cpl.getNextCreditPeer();
}
                
or
while (cpl.hasNext()) {
     CreditPeer[] peers = cpl.getNextCreditPeers(cpl.available());
}
                
MethodgetNextCreditPeer
Description

Gets the next CreditPeer in this list.

Returnosid.acknowledgement.batch.CreditPeer the next CreditPeer in this list. The hasNext() method should be used to test that a next CreditPeer 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.
MethodgetNextCreditPeers
Description

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

Parameterscardinaln the number of CreditPeer elements requested which must be less than or equal to available()
Returnosid.acknowledgement.batch.CreditPeer[] an array of CreditPeer 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.