Interface AssetBatchFormList

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

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

while (abfl.hasNext()) {
     AssetBatchForm form = abfl.getNextAssetBatchForm();
}
or 
while (abfl.hasNext()) {
     AssetBatchForm[] forms = abfl.getNextAssetBatchForms(abfl.available());
}

Like all OsidLists, AssetBatchFormList is stateful and must not be accessed by multiple processing threads.

  • Method Details

    • getNextAssetBatchForm

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

    • getNextAssetBatchForms

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