OSID Logo
OSID Specifications
ordering batch package
Version 3.1.0
Interfaceosid.ordering.batch.OrderItemPeerList
Implementsosid.OsidList
Description

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

while (ipl.hasNext()) {
     OrderItemPeer peer = ipl.getNextOrderItemPeer();
}
                
or
while (ipl.hasNext()) {
     OrderItemPeer[] peers = ipl.getNextOrderItemPeers(ipl.available());
}
                

Like all OsidLists, OrderItemPeerList is stateful and must not be accessed by multiple processing threads.

MethodgetNextOrderItemPeer
Description

Gets the next OrderItemPeer in this list.

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

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

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