Interface CredentialEntryBatchFormList

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

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

while (cbfl.hasNext()) {
     CredentialEntryBatchForm form = cbfl.getNextCredentialEntryBatchForm();
}
or 
while (cbfl.hasNext()) {
     CredentialEntryBatchForm[] forms = cbfl.getNextCredentialEntryBatchForms(cbfl.available());
}

  • Method Details

    • getNextCredentialEntryBatchForm

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

    • getNextCredentialEntryBatchForms

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