org.osid.tracking

Interface QueueList

All Superinterfaces:

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

public interface QueueList
extends OsidList

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

       
       
       while (ql.hasNext()) {
            Queue queue = ql.getNextQueue();
       }
       
                   
       
  

or

       
       
       while (ql.hasNext()) {
            Queue[] queues = ql.getNextQueues(ql.available());
       }
       
                   
       
  

Method Summary

Methods

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

getNextQueue

Queue getNextQueue()
                   throws OperationFailedException

Gets the next Queue in this list.

Returns:

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

getNextQueues

Queue[] getNextQueues(long n)
                      throws OperationFailedException

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

Parameters:

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

Returns:

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