org.osid.authorization

Interface QualifierList

All Superinterfaces:

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

public interface QualifierList
extends OsidList

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

       
       
       while (ql.hasNext()) {
            Qualifier qualifier = ql.getNextQualifier();
       }
       
                   
       
  

or

       
       
       while (ql.hasNext()) {
            Qualifier[] qualifiers = ql.hetNextQualifiers(ql.available());
       }
       
                   
       
  

Method Summary

Methods

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

getNextQualifier

Qualifier getNextQualifier()
                           throws OperationFailedException

Gets the next Qualifier in this list.

Returns:

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

getNextQualifiers

Qualifier[] getNextQualifiers(long n)
                              throws OperationFailedException

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

Parameters:

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

Returns:

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