org.osid.course.program

Interface CredentialList

All Superinterfaces:

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

public interface CredentialList
extends OsidList

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

       
       
       while (cl.hasNext()) {
            Credential credential = cl.getNextCredential();
       }
       
                   
       
  

or

       
       
       while (cl.hasNext()) {
            Credential[] credentials = cl.getNextCredentials(cl.available());
       }
       
                   
       
  

Method Summary

Methods

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

getNextCredential

Credential getNextCredential()
                             throws OperationFailedException

Gets the next Credential in this list.

Returns:

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

getNextCredentials

Credential[] getNextCredentials(long n)
                                throws OperationFailedException

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

Parameters:

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

Returns:

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