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()); }
Modifier and Type | Method and 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(). |
CyclicTimePeriod getNextCyclicTimePeriod() throws OperationFailedException
CyclicTimePeriod
in this list. CyclicTimePeriod
in this list. The
hasNext()
method should be used to test that a
next CyclicTimePeriod
is available before
calling this method.IllegalStateException
- no more elements available in
this listOperationFailedException
- unable to complete requestmandatory
- This method must be implemented. CyclicTimePeriod[] getNextCyclicTimePeriods(long n) throws OperationFailedException
CyclicTimePeriod
elements in this
list which must be less than or equal to the number returned from
available().
n
- the number of CyclicTimePeriod
elements
requested which should be less than or equal to
available()
CyclicTimePeriod
elements.
The length of the array is less than or equal to the
number specified.IllegalStateException
- no more elements available in
this listOperationFailedException
- unable to complete requestmandatory
- This method must be implemented.