org.osid.billing

Interface PeriodList

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidList

public interface PeriodList
extends OsidList

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

       
       
       while (pl.hasNext()) {
            Period period = pl.getNextPeriod();
       }
       
                   
       
  

or

       
       
       while (pl.hasNext()) {
            Period[] periods = pl.getNextPeriods(pl.available());
       }
       
                   
       
  

Method Summary

Methods

Modifier and Type	Method and Description
Period	getNextPeriod() Gets the next Period in this list.
Period[]	getNextPeriods(long n) Gets the next set of Period elements in this list.

Methods inherited from interface org.osid.OsidList

available, hasNext, skip

Methods inherited from interface org.osid.binding.java.OsidList

close

Methods inherited from interface java.io.Closeable

close

Method Detail

getNextPeriod

Period getNextPeriod()
                     throws OperationFailedException

Gets the next Period in this list.

Returns:

the next Period in this list. The hasNext() method should be used to test that a next Period 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.

getNextPeriods

Period[] getNextPeriods(long n)
                        throws OperationFailedException

Gets the next set of Period elements in this list. The specified amount must be less than or equal to the return from available().

Parameters:

n - the number of Period elements requested which must be less than or equal to available()

Returns:

an array of Period 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.