Interface ProgramOfferingList

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

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

while (pol.hasNext()) {
     ProgramOffering offering = pol.getNextProgramOffering();
}
or 
while (pol.hasNext()) {
     ProgramOffering[] offerings = pol.getNextProgramOfferings(pol.available());
}

  • Method Details

    • getNextProgramOffering

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

    • getNextProgramOfferings

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