org.osid.authentication.process

Interface TrustList

All Superinterfaces:

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

public interface TrustList
extends OsidList

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

       
       
       while (tl.hasNext()) {
            Trust trust = tl.getNextTrust();
       }
       
                   
       
  

or

       
       
       while (tl.hasNext()) {
            Trust[] trusts = tl.getNextTrusts(tl.available());
       }
       
                   
       
  

Method Summary

Methods

Modifier and Type	Method and Description
Trust	getNextTrust() Gets the next Trust in this list.
Trust[]	getNextTrusts(long n) Gets the next set of Trust elements in this list which must be less than or equal to the return 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

getNextTrust

Trust getNextTrust()
                   throws OperationFailedException

Gets the next Trust in this list.

Returns:

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

getNextTrusts

Trust[] getNextTrusts(long n)
                      throws OperationFailedException

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

Parameters:

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

Returns:

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