Interface SubscriptionBatchFormList

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

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

while (sbfl.hasNext()) {
     SubscriptionBatchForm form = sbfl.getNextSubscriptionBatchForm();
}
or 
while (sbfl.hasNext()) {
     SubscriptionBatchForm[] forms = sbfl.getNextSubscriptionBatchForms(sbfl.available());
}

  • Method Details

    • getNextSubscriptionBatchForm

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

    • getNextSubscriptionBatchForms

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