Interface AssetSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface AssetSearch
extends OsidSearch

The search interface for governing asset searches.

Method Summary

Modifier and Type	Method	Description
AssetSearchRecord	getAssetSearchRecord(Type assetSearchRecordType)	Gets the asset search record corresponding to the given asset search record Type.
void	orderAssetResults(AssetSearchOrder assetSearchOrder)	Specify an ordering to the search results.
void	searchAmongAssets(IdList assetIds)	Execute this search among the given list of assets.

Methods inherited from interface Extensible

getRecordTypes, hasRecordType

Modifier and Type	Method	Description
TypeList	getRecordTypes()	Gets the record types available in this object.
boolean	hasRecordType(Type recordType)	Tests if this object supports the given record Type.

Methods inherited from interface OsidSearch

limitResultSet

Modifier and Type	Method	Description
void	limitResultSet(long start, long end)	By default, searches return all matching results.

Method Details

searchAmongAssets

void searchAmongAssets(IdList assetIds)

Execute this search among the given list of assets.

Parameters:

assetIds - list of asset Ids

Throws:

NullArgumentException - assetIds is null

Compliance:

mandatory - This method must be implemented.

orderAssetResults

void orderAssetResults(AssetSearchOrder assetSearchOrder)

Specify an ordering to the search results.

Parameters:

assetSearchOrder - asset search order

Throws:

NullArgumentException - assetSearchOrder is null

UnsupportedException - assetSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getAssetSearchRecord

AssetSearchRecord getAssetSearchRecord(Type assetSearchRecordType)
                                throws OperationFailedException

Gets the asset search record corresponding to the given asset search record Type. This method used to retrieve an object implementing the requested record.

Parameters:

assetSearchRecordType - an asset search record type

Returns:

the asset search record

Throws:

NullArgumentException - assetSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(assetSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.