org.osid.provisioning

Interface ProvisionList

All Superinterfaces:

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

public interface ProvisionList
extends OsidList

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

       
       
       while (pl.hasNext()) {
            Provision provision = pl.getNextProvision();
       }
       
                   
       
  

or

       
       
       while (pl.hasNext()) {
            Provision[] provisions = pl.getNextProvisions(pl.available());
       }
       
                   
       
  

Method Summary

Methods

Modifier and Type	Method and Description
Provision	getNextProvision() Gets the next Provision in this list.
Provision[]	getNextProvisions(long n) Gets the next set of Provision elements in this list.

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

getNextProvision

Provision getNextProvision()
                           throws OperationFailedException

Gets the next Provision in this list.

Returns:

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

getNextProvisions

Provision[] getNextProvisions(long n)
                              throws OperationFailedException

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

Parameters:

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

Returns:

an array of Provision 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.