Interface CyclicTimePeriodList

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

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

while (ctpl.hasNext()) {
     CyclicTimePeriod period = ctpl.getNextCyclicTimePeriod();
}
or 
while (ctpl.hasNext()) {
     CyclicTimePeriod[] periods = ctpl.getNextCyclicTimePeriods(ctpl.available());
}

  • Method Summary

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

    • getNextCyclicTimePeriod

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

    • getNextCyclicTimePeriods

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