org.osid.resourcing.rules

Interface JobConstrainerEnablerList

All Superinterfaces:

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

public interface JobConstrainerEnablerList
extends OsidList

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

       
       
       while (jcel.hasNext()) {
            JobConstrainerEnabler enabler = jcel.getNextJobConstrainerEnabler();
       }
       
                   
       
  

or

       
       
       while (jcel.hasNext()) {
            JobConstrainerEnabler[] enablers = jcel.getNextJobConstrainerEnablers(jcel.available());
       }
       
                   
       
  

Method Summary

Methods

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

getNextJobConstrainerEnabler

JobConstrainerEnabler getNextJobConstrainerEnabler()
                                                   throws OperationFailedException

Gets the next JobConstrainerEnabler in this list.

Returns:

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

getNextJobConstrainerEnablers

JobConstrainerEnabler[] getNextJobConstrainerEnablers(long n)
                                                      throws OperationFailedException

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

Parameters:

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

Returns:

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