Interface ProvisionableEnablerList

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

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

while (pel.hasNext()) {
     ProvisionableEnabler enabler = pel.getNextProvisionableEnabler();
}

or

while (pel.hasNext()) {
     ProvisionableEnabler[] enablers = pel.getNextProvisionableEnablers(pel.available());
}

  • Method Details

    • getNextProvisionableEnabler

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

    • getNextProvisionableEnablers

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