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