Interface BrokerConstrainerList

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

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

while (bcl.hasNext()) {
     BrokerConstrainer constrainer = bcl.getNextBrokerConstrainer();
}

or

while (bcl.hasNext()) {
     BrokerConstrainer[] constrainers = bcl.getNextBrokerConstrainers(bcl.available());
}

  • Method Details

    • getNextBrokerConstrainer

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

    • getNextBrokerConstrainers

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