org.osid.resourcing.rules

Interface JobConstrainerList

All Superinterfaces:

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

public interface JobConstrainerList
extends OsidList

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

       
       
       while (jcl.hasNext()) {
            JobConstrainer constrainer = jcl.getNextJobConstrainer();
       }
       
                   
       
  

or

       
       
       while (jcl.hasNext()) {
            JobConstrainer[] constrainers = jcl.getNextJobConstrainers(jcl.available());
       }
       
                   
       
  

Method Summary

Methods

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

getNextJobConstrainer

JobConstrainer getNextJobConstrainer()
                                     throws OperationFailedException

Gets the next JobConstrainer in this list.

Returns:

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

getNextJobConstrainers

JobConstrainer[] getNextJobConstrainers(long n)
                                        throws OperationFailedException

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

Parameters:

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

Returns:

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