org.osid.room.construction

Interface ProjectList

All Superinterfaces:

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

public interface ProjectList
extends OsidList

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

       
       
       while (dl.hasNext()) {
           Project = dl.getNextProject();
       }
       
                   
       
  

or

       
       
       while (dl.hasNext()) {
           Project[] projects = dl.getNextProjects(dl.available());
       }
       
                   
       
  

Method Summary

Methods

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

getNextProject

Project getNextProject()
                       throws OperationFailedException

Gets the next Project in this list.

Returns:

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

getNextProjects

Project[] getNextProjects(long n)
                          throws OperationFailedException

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

Parameters:

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

Returns:

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