OSID Logo
OSID Specifications
ordering package
Version 3.0.0
Release Candidate Preview
Interfaceosid.ordering.OrderList
Implementsosid.OsidList
Description

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

                     
                     
                     while (ol.hasNext()) {
                          Order order = ol.getNextOrder();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (ol.hasNext()) {
                          Order[] orders = ol.getNextOrders(ol.available());
                     }
                     
                                 
                     
                
MethodgetNextOrder
Description

Gets the next Order in this list.

Returnosid.ordering.Orderthe next Order in this list. The hasNext() method should be used to test that a next Order is available before calling this method.
ErrorsILLEGAL_STATEno more elements available in this list
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetNextOrders
Description

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

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