Interface ProjectList

All Superinterfaces:

AutoCloseable, Closeable, OsidList, 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

Modifier and Type	Method	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 Closeable

close

Methods inherited from interface OsidList

close

Modifier and Type	Method	Description
void	close()	Close this list.

Methods inherited from interface OsidList

available, hasNext, skip

Modifier and Type	Method	Description
long	available()	Gets the number of elements available for retrieval.
boolean	hasNext()	Tests if there are more elements in this list.
void	skip(long n)	Skip the specified number of elements in the list.

Method Details

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.