Interface ProfileEntryList

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

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

while (pel.hasNext()) {
     ProfileEntry entry = pel.getNextProfileEntry();
}
or 
while (pel.hasNext()) {
     ProfileEntry[] entries = pel.getNextProfileEntries(pel.available());
}

  • Method Summary

    Modifier and Type
    Method
    Description
    ProfileEntry[]
    getNextProfileEntries(long n)
    Gets the next set of ProfileEntry elements in this list which must be less than or equal to the number returned from available() .
    ProfileEntry
    getNextProfileEntry()
    Gets the next ProfileEntry in this list.

    Methods inherited from interface Closeable

    close

    Methods inherited from interface OsidList

    close
    Modifier and Type
    Method
    Description
    void
    close()
    Close this list.

    Methods inherited from interface OsidList

    available, hasNext, skip
    Modifier and Type
    Method
    Description
    long
    available()
    Gets the number of elements available for retrieval.
    boolean
    hasNext()
    Tests if there are more elements in this list.
    void
    skip(long n)
    Skip the specified number of elements in the list.

  • Method Details

    • getNextProfileEntry

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

    • getNextProfileEntries

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