Interface BuildingBatchFormList

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

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

while (bbfl.hasNext()) {
     BuildingBatchForm form = bbfl.getNextBuildingBatchForm();
}
or 
while (bbfl.hasNext()) {
     BuildingBatchForm[] forms = bbfl.getNextBuildingBatchForms(bbfl.available());
}

  • Method Details

    • getNextBuildingBatchForm

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

    • getNextBuildingBatchForms

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