org.osid.authorization

Interface AuthorizationList

All Superinterfaces:

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

public interface AuthorizationList
extends OsidList

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

       
       
       while (al.hasNext()) {
            Authorization authorization = al.getNextAuthorization();
       }
       
                   
       
  

or

       
       
       while (al.hasNext()) {
            Authorization[] authorizations = al.getNextAuthorizations(al.available());
       }
       
                   
       
  

Method Summary

Methods

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

getNextAuthorization

Authorization getNextAuthorization()
                                   throws OperationFailedException

Gets the next Authorization in this list.

Returns:

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

getNextAuthorizations

Authorization[] getNextAuthorizations(long n)
                                      throws OperationFailedException

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

Parameters:

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

Returns:

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