Interface TimePeriodList

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

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

while (tp.hasNext()) {
     TimePeriod period = tp.getNextTimePeriod();
}
or 
while (tp.hasNext()) {
     TimePeriod[] periods = tp.getNextTimePeriods(tp.available());
}

  • Method Summary

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

    • getNextTimePeriod

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

    • getNextTimePeriods

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