Interface SubjectList

All Superinterfaces:

AutoCloseable, Closeable, OsidList, OsidList

public interface SubjectList
extends OsidList

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

while (sl.hasNext()) {
     Subject subject = sl.getNextSubject();
}            
  

or

while (sl.hasNext()) {
     Subject[] subjects = sl.getNextSubjects(sl.available());
}            
  

Method Summary

Modifier and Type	Method	Description
Subject	getNextSubject()	Gets the next Subject in this list.
Subject[]	getNextSubjects(long n)	Gets the next set of Subject elements in this list which must be less than or equal to the number returned from available() .

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

getNextSubject

Subject getNextSubject()
                throws OperationFailedException

Gets the next Subject in this list.

Returns:

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

getNextSubjects

Subject[] getNextSubjects(long n)
                   throws OperationFailedException

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

Parameters:

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

Returns:

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