org.osid.process

Interface ProcessList

All Superinterfaces:

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

public interface ProcessList
extends OsidList

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

       
       
       while (pl.hasNext()) {
            Process process = pl.getNextProcess();
       }
       
                   
       
  

or

       
       
       while (pl.hasNext()) {
            Process[] processes = pl.getNextProcesses(pl.available());
       }
       
                   
       
  

Method Summary

Methods

Modifier and Type	Method and Description
Process	getNextProcess() Gets the next Process in this list.
Process[]	getNextProcesses(long n) Gets the next set of Process elements in this list which must be less than or equal to the return from available().

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

getNextProcess

Process getNextProcess()
                       throws OperationFailedException

Gets the next Process in this list.

Returns:

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

getNextProcesses

Process[] getNextProcesses(long n)
                           throws OperationFailedException

Gets the next set of Process elements in this list which must be less than or equal to the return from available().

Parameters:

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

Returns:

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