Interface CredentialEntryList

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

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

while (cel.hasNext()) {
     CredentialEntry entry = cel.getNextCredentialEntry();
}
or 
while (cel.hasNext()) {
     CredentialEntry[] entry = cel.getNextCredentialEntries(cel.available());
}

  • Method Details

    • getNextCredentialEntry

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

    • getNextCredentialEntries

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