Interface ProgramEntryList

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

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

while (pel.hasNext()) {
     ProgramEntry entry = pel.getNextProgramEntry();
}
or 
while (pel.hasNext()) {
     ProgramEntry[] enrties = pel.getNextProgramEntries(pel.available());
}

Like all OsidLists, ProgramEntryList is stateful and must not be accessed by multiple processing threads.

  • Method Details

    • getNextProgramEntry

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

    • getNextProgramEntries

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