org.osid.repository

Interface AssetList

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, 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

Methods

Modifier and Type	Method and 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 org.osid.OsidList

available, hasNext, skip

Methods inherited from interface org.osid.binding.java.OsidList

close

Methods inherited from interface java.io.Closeable

close

Method Detail

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.