Interface ScheduleSlotList

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

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

while (ssl.hasNext()) {
     ScheduleSlot slot = ssl.getNextSchedulSlote();
}
or 
while (ssl.hasNext()) {
     ScheduleSlot[] slots = ssl.getNextScheduleSlots(ssl.available());
}

  • Method Summary

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

    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

    • getNextScheduleSlot

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

    • getNextScheduleSlots

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