OSID Logo
OSID Specifications
ordering package
Version 3.1.0
Interfaceosid.ordering.OrderItemList
Implementsosid.OsidList
Used Byosid.ordering.OrderItemLookupSession
osid.ordering.OrderItemQuerySession
osid.ordering.OrderItemSearchResults
osid.ordering.OrderItemStoreSession
Description

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

while (il.hasNext()) {
     OrderItem order item = il.getNextOrderItem();
}
                
or
while (il.hasNext()) {
     OrderItem[] order items = il.getNextOrderItems(il.available());
}
                

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

MethodgetNextOrderItem
Description

Gets the next OrderItem in this list.

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

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

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