Interface FamilyList

All Superinterfaces:

AutoCloseable, Closeable, OsidList, OsidList

public interface FamilyList
extends OsidList

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

while (fl.hasNext()) {
     Family family = fl.getNextFamily();
}            
  

or

while (fl.hasNext()) {
     Family[] families = fl.getNextFamilies(fl.available());
}            
  

Method Summary

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

getNextFamily

Family getNextFamily()
              throws OperationFailedException

Gets the next Family in this list.

Returns:

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

getNextFamilies

Family[] getNextFamilies(long n)
                  throws OperationFailedException

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

Parameters:

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

Returns:

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