Interface AssetContentSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface AssetContentSearch
extends OsidSearch

The search interface for governing asset content searches.

Method Summary

Modifier and Type	Method	Description
AssetContentSearchRecord	getAssetContentSearchRecord(Type assetContentSearchRecordType)	Gets the asset content search record corresponding to the given asset content search record Type .This method is used to retrieve an object implementing the requested record.
void	orderAssetContentResults(AssetContentSearchOrder assetContentSearchOrder)	Specify an ordering to the search results.
void	searchAmongAssetContents(IdList assetContentIds)	Execute this search among the given list of asset contents.

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

searchAmongAssetContents

void searchAmongAssetContents(IdList assetContentIds)

Execute this search among the given list of asset contents.

Parameters:

assetContentIds - list of asset contents

Throws:

NullArgumentException - assetContentIds is null

Compliance:

mandatory - This method must be implemented.

orderAssetContentResults

void orderAssetContentResults(AssetContentSearchOrder assetContentSearchOrder)

Specify an ordering to the search results.

Parameters:

assetContentSearchOrder - asset content search order

Throws:

NullArgumentException - assetContentSearchOrder is null

UnsupportedException - assetContentSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getAssetContentSearchRecord

AssetContentSearchRecord getAssetContentSearchRecord(Type assetContentSearchRecordType)
                                              throws OperationFailedException

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

Parameters:

assetContentSearchRecordType - an asset content search record type

Returns:

the asset content search record

Throws:

NullArgumentException - assetContentSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(assetContentSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.