Interface PackageList

All Superinterfaces:

AutoCloseable, Closeable, OsidList, OsidList

public interface PackageList
extends OsidList

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

while (pl.hasNext()) {
     Package package = pl.getNextPackage();
}            
  

or

while (pl.hasNext()) {
     Package[] packages = pl.getNextPackages(pl.available());
}            
  

Method Summary

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

getNextPackage

Package getNextPackage()
                throws OperationFailedException

Gets the next Package in this list.

Returns:

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

getNextPackages

Package[] getNextPackages(long n)
                   throws OperationFailedException

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

Parameters:

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

Returns:

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