org.osid.filing.allocation

Interface AllocationList

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidList

public interface AllocationList
extends OsidList

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());
       }
       
                   
       
  

Method Summary

Methods

Modifier and Type	Method and Description
Allocation	getNextAllocation() Gets the next Allocation in this list.
Allocation[]	getNextAllocations(long n) Gets the next set of Allocation elements in this list which must be less than or equal to the number returned from available().

Methods inherited from interface org.osid.OsidList

available, hasNext, skip

Methods inherited from interface org.osid.binding.java.OsidList

close

Methods inherited from interface java.io.Closeable

close

Method Detail

getNextAllocation

Allocation getNextAllocation()
                             throws OperationFailedException

Gets the next Allocation in this list.

Returns:

the next Allocation in this list. The hasNext() method should be used to test that a next Allocation is available before calling this method.

Throws:

IllegalStateException - no more elements available in this list

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

getNextAllocations

Allocation[] getNextAllocations(long n)
                                throws OperationFailedException

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

Parameters:

n - the number of Allocation elements requested which should be less than or equal to available()

Returns:

an array of Allocation elements. The length of the array is less than or equal to the number specified.

Throws:

IllegalStateException - no more elements available in this list

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.