Interface CanonicalUnitProcessorEnablerList

All Superinterfaces:

AutoCloseable, Closeable, OsidList, OsidList

public interface CanonicalUnitProcessorEnablerList
extends OsidList

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

while (cupel.hasNext()) {
     CanonicalUnitProcessorEnabler enabler = cupel.getNextCanonicalUnitProcessorEnabler();
}            
  

or

while (cupel.hasNext()) {
     CanonicalUnitProcessorEnabler[] enablers = cupel.getNextCanonicalUnitProcessorEnablers(cupel.available());
}            
  

Method Summary

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

getNextCanonicalUnitProcessorEnabler

CanonicalUnitProcessorEnabler getNextCanonicalUnitProcessorEnabler()
                                                            throws OperationFailedException

Gets the next CanonicalUnitProcessorEnabler in this list.

Returns:

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

getNextCanonicalUnitProcessorEnablers

CanonicalUnitProcessorEnabler[] getNextCanonicalUnitProcessorEnablers(long n)
                                                               throws OperationFailedException

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

Parameters:

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

Returns:

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