edu.indiana.lib.osid.base.repository.http

Class AssetIterator

java.lang.Object

edu.indiana.lib.osid.base.repository.AssetIterator

edu.indiana.lib.osid.base.repository.http.AssetIterator

All Implemented Interfaces:

Serializable, org.osid.repository.AssetIterator

public class AssetIterator
extends AssetIterator

Version:

Author:

Massachusetts Institute of Techbology, Sakai Software Development Team

See Also:

Serialized Form

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AssetIterator(String database, QueryBase queryBase, SearchResultBase searchResult, org.osid.shared.Properties searchProperties, org.osid.shared.Id repositoryId, SessionContext sessionContext) Constructor
protected	AssetIterator(Vector vector) Unused constructor

Method Summary

Modifier and Type	Method and Description
boolean	hasNextAsset() Is another Asset available?
protected void	initialize(org.osid.shared.Properties searchProperties) Initialize
org.osid.repository.Asset	nextAsset() Fetch the next available search result (from the "Asset queue")

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AssetIterator

protected AssetIterator(Vector vector)

Unused constructor

AssetIterator

protected AssetIterator(String database,
                        QueryBase queryBase,
                        SearchResultBase searchResult,
                        org.osid.shared.Properties searchProperties,
                        org.osid.shared.Id repositoryId,
                        SessionContext sessionContext)
                 throws org.osid.repository.RepositoryException

Constructor

Parameters:

database - The database (or target) for this search

searchProperties - Property list (search characteristics, provided by our caller)

repositoryId - Unique Repository ID

sessionContext - Context data for the current user/caller

Throws:

org.osid.repository.RepositoryException

Method Detail

initialize

protected void initialize(org.osid.shared.Properties searchProperties)
                   throws org.osid.shared.SharedException

Initialize

Parameters:

searchProperties - Property list (search characteristics, provided by our caller)

Throws:

org.osid.shared.SharedException

hasNextAsset

public boolean hasNextAsset()
                     throws org.osid.repository.RepositoryException

Is another Asset available? If so, set the search status as "complete".

Specified by:

hasNextAsset in interface org.osid.repository.AssetIterator

Overrides:

hasNextAsset in class AssetIterator

Returns:

true if an Asset is available, false if not

Throws:

org.osid.repository.RepositoryException

nextAsset

public org.osid.repository.Asset nextAsset()
                                    throws org.osid.repository.RepositoryException

Fetch the next available search result (from the "Asset queue")

Specified by:

nextAsset in interface org.osid.repository.AssetIterator

Overrides:

nextAsset in class AssetIterator

Returns:

The next search result (as an Asset)

Throws:

org.osid.repository.RepositoryException