Interface AwardEntryList

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

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

while (ael.hasNext()) {
     AwardEntry entry = ael.getNextAwardEntry();
}
or 
while (ael.hasNext()) {
     AwardEntry[] entries = ael.getNextAwardEntries(ael.available());
}

  • Method Summary

    Modifier and Type
    Method
    Description
    AwardEntry[]
    getNextAwardEntries(long n)
    Gets the next set of AwardEntry elements in this list.
    AwardEntry
    getNextAwardEntry()
    Gets the next AwardEntry 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

    • getNextAwardEntry

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

    • getNextAwardEntries

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