Interface ProfileItemBatchFormList

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

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

while (pibfl.hasNext()) {
     ProfileItemBatchForm form = pibfl.getNextProfileItemBatchForm();
}
or 
while (pibfl.hasNext()) {
     ProfileItemBatchForm[] forms = pibfl.getNextProfileItemBatchForms(pibfl.available());
}

  • Method Details

    • getNextProfileItemBatchForm

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

    • getNextProfileItemBatchForms

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