Interface ProfileEntryEnablerList

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

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

while (pel.hasNext()) {
     ProfileEntryEnabler enabler = pel.getNextProfileEntryEnabler();
}
or 
while (pel.hasNext()) {
     ProfileEntryEnabler[] enablers = pel.getNextProfileEntryEnablers pel.available());
}

  • Method Details

    • getNextProfileEntryEnabler

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

    • getNextProfileEntryEnablers

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