Interface DemographicEnablerList

All Superinterfaces:
AutoCloseable, Closeable, OsidList, OsidList

public interface DemographicEnablerList extends OsidList

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

while (del.hasNext()) {
     DemographicEnabler enabler = del.getNextDemographicEnabler();
}            
  
or
while (del.hasNext()) {
     DemographicEnabler[] enablers = del.getNextDemographicEnablers(del.available());
}            
  
  • Method Details

    • getNextDemographicEnabler

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

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