Interface OfferingConstrainerList

All Superinterfaces:

AutoCloseable, Closeable, OsidList, OsidList

public interface OfferingConstrainerList
extends OsidList

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

while (ocl.hasNext()) {
     OfferingConstrainer = ocl.getNextOfferingConstrainer();
}            
  

or

while (ocl.hasNext()) {
     OfferingConstrainer[] = ocel.getNextOfferingConstrainers(ocl.available());
}            
  

Method Summary

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

getNextOfferingConstrainer

OfferingConstrainer getNextOfferingConstrainer()
                                        throws OperationFailedException

Gets the next OfferingConstrainer in this list.

Returns:

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

getNextOfferingConstrainers

OfferingConstrainer[] getNextOfferingConstrainers(long n)
                                           throws OperationFailedException

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

Parameters:

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

Returns:

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