Interface CredentialRequirementList

All Superinterfaces:
AutoCloseable, Closeable, OsidList, OsidList
public interface CredentialRequirementList extends OsidList

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

while (crl.hasNext()) {
     CredentialRequirement req = crl.getNextCredentialRequirement();
}
or 
while (crl.hasNext()) {
     CredentialRequirement[] reqs = crl.getNextCredentialRequirements(crl.available());
}

  • Method Details

    • getNextCredentialRequirement

      CredentialRequirement getNextCredentialRequirement() throws OperationFailedException
      Gets the next CredentialRequirement in this list.
      Returns:
      the next CredentialRequirement in this list. The hasNext() method should be used to test that a next CredentialRequirement 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.

    • getNextCredentialRequirements

      CredentialRequirement[] getNextCredentialRequirements(long n) throws OperationFailedException
      Gets the next set of CredentialRequirement elements in this list. The specified amount must be less than or equal to the return from available() .
      Parameters:
      n - the number of CredentialRequirement elements requested which must be less than or equal to available()
      Returns:
      an array of CredentialRequirement 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.