public interface AssetSearch extends OsidSearch
The search interface for governing asset searches.
Modifier and Type | Method and 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.
|
limitResultSet
getRecordTypes, hasRecordType
void searchAmongAssets(IdList assetIds)
assetIds
- list of asset Ids
NullArgumentException
- assetIds
is
null
mandatory
- This method must be implemented. void orderAssetResults(AssetSearchOrder assetSearchOrder)
assetSearchOrder
- asset search orderNullArgumentException
- assetSearchOrder
is null
UnsupportedException
- assetSearchOrder
is not of this servicemandatory
- This method must be implemented. AssetSearchRecord getAssetSearchRecord(Type assetSearchRecordType) throws OperationFailedException
Type.
This method used to retrieve an object
implementing the requested record.assetSearchRecordType
- an asset search record typeNullArgumentException
- assetSearchRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(assetSearchRecordType)
is false
mandatory
- This method must be implemented.