org.osid.provisioning.rules

Interface QueueProcessorList

All Superinterfaces:

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

public interface QueueProcessorList
extends OsidList

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

       
       
       while (qpl.hasNext()) {
            QueueProcessor processor = qpl.getNextQueueProcessor();
       }
       
                   
       
  

or

       
       
       while (qpl.hasNext()) {
            QueueProcessor[] processor = qpl.getNextQueueProcessors(qpl.available());
       }
       
                   
       
  

Method Summary

Methods

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

getNextQueueProcessor

QueueProcessor getNextQueueProcessor()
                                     throws OperationFailedException

Gets the next QueueProcessor in this list.

Returns:

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

getNextQueueProcessors

QueueProcessor[] getNextQueueProcessors(long n)
                                        throws OperationFailedException

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

Parameters:

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

Returns:

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