Interface PlanList

All Superinterfaces:

AutoCloseable, Closeable, OsidList, OsidList

public interface PlanList
extends OsidList

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

while (pl.hasNext()) {
     Plan plan = pl.getNextPlan();
}            
  

or

while (pl.hasNext()) {
     Plan[] plans = pl.getNextPlans(pl.available());
}            
  

Method Summary

Modifier and Type	Method	Description
Plan	getNextPlan()	Gets the next Plan in this list.
Plan[]	getNextPlans(long n)	Gets the next set of Plan elements in this list.

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

getNextPlan

Plan getNextPlan()
          throws OperationFailedException

Gets the next Plan in this list.

Returns:

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

getNextPlans

Plan[] getNextPlans(long n)
             throws OperationFailedException

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

Parameters:

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

Returns:

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