Interface BrokerProcessorEnablerList

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

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

while (bpel.hasNext()) {
     BrokerProcessorEnabler enabler = bpel.getNextBrokerProcessorEnabler();
}

or

while (bpel.hasNext()) {
     BrokerProcessorEnabler[] enablers = bpel.getNextBrokerProcessorEnablers(bpel.available());
}

  • Method Details

    • getNextBrokerProcessorEnabler

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

    • getNextBrokerProcessorEnablers

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