Interface DateTimeList

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

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

while (dtl.hasNext()) {
     DateTime time = dtl.getNextDateTime();
}
or 
while dtl.hasNext()) {
     DateTime[] times = dtl.getNextDateTimes(dtl.available());
}

  • Method Summary

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

    • getNextDateTime

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

    • getNextDateTimes

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