org.osid.transaction.batch

Interface AliasResponseList

All Superinterfaces:

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

public interface AliasResponseList
extends OsidList

Like all OsidLists,

       
       
       AliasResponseList
       
                   
       
  

provides a means for accessing AliasResponse elements sequentially either one at a time or many at a time. Examples:

       
       
       while arl.hasNext()) {
            AliasResponse response = arl.getNextAliasResponse();
       }
       
                   
       
  

or

       
       
       while (arl.hasNext()) {
            AliasResponse[] responses = arl.getNextAliasResponses(arl.available());
       }
       
                   
       
  

Method Summary

Methods

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

getNextAliasResponse

AliasResponse getNextAliasResponse()
                                   throws OperationFailedException

Gets the next AliasResponse in this list.

Returns:

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

getNextAliasResponses

AliasResponse[] getNextAliasResponses(long n)
                                      throws OperationFailedException

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

Parameters:

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

Returns:

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