org.osid.provisioning

Interface RequestList

All Superinterfaces:

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

public interface RequestList
extends OsidList

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

       
       
       while (rl.hasNext()) {
            Request request = rl.getNextRequest();
       }
       
                   
       
  

or

       
       
       while (rl.hasNext()) {
            Request[] requests = rl.getNextRequests(rl.available());
       }
       
                   
       
  

Method Summary

Methods

Modifier and Type	Method and Description
Request	getNextRequest() Gets the next Request in this list.
Request[]	getNextRequests(long n) Gets the next set of Request 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

getNextRequest

Request getNextRequest()
                       throws OperationFailedException

Gets the next Request in this list.

Returns:

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

getNextRequests

Request[] getNextRequests(long n)
                          throws OperationFailedException

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

Parameters:

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

Returns:

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