Interface BrokerConstrainerEnablerList

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

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

while (bcel.hasNext()) {
     BrokerConstrainerEnabler enabler = bcel.getNextBrokerConstrainerEnabler();
}

or

while (bcel.hasNext()) {
     BrokerConstrainerEnabler[] enablers = bcel.getNextBrokerConstrainerEnablers(bcel.available());
}

  • Method Details

    • getNextBrokerConstrainerEnabler

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

    • getNextBrokerConstrainerEnablers

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