OSID Logo
OSID Specifications
filing allocation package
Version 3.0.0
Release Candidate Preview
Interfaceosid.filing.allocation.AllocationList
Implementsosid.OsidList
Description

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

                     
                     
                     while (al.hasNext()) {
                          Allocation allocation = al.getNextAllocation();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (al.hasNext()) {
                          Allocation[] allocations = al.getNextAllocations(al.available());
                     }
                     
                                 
                     
                
MethodgetNextAllocation
Description

Gets the next Allocation in this list.

Returnosid.filing.allocation.Allocationthe next Allocation in this list. The hasNext() method should be used to test that a next Allocation is available before calling this method.
ErrorsILLEGAL_STATEno more elements available in this list
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetNextAllocations
Description

Gets the next set of Allocation elements in this list which must be less than or equal to the number returned from available().

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