Interface AssetList

All Superinterfaces:

AutoCloseable, Closeable, OsidList, OsidList

public interface AssetList
extends OsidList

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

while (al.hasNext()) {
     Asset asset = al.getNextAsset();
}            
  

or

while (al.hasNext()) {
     Asset[] assets = al.getNextAssets(al.available());
}            
  

Method Summary

Modifier and Type	Method	Description
Asset	getNextAsset()	Gets the next Asset in this list.
Asset[]	getNextAssets(long n)	Gets the next set of Assets in this list which must be less than or equal to the return 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

getNextAsset

Asset getNextAsset()
            throws OperationFailedException

Gets the next Asset in this list.

Returns:

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

getNextAssets

Asset[] getNextAssets(long n)
               throws OperationFailedException

Gets the next set of Assets in this list which must be less than or equal to the return from available() .

Parameters:

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

Returns:

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