public interface AssetSearchSession extends AssetQuerySession
This session provides methods for searching among Asset
objects. The search query is constructed using the AssetQuery.
getAssetsByQuery()
is the basic search method and
returns a list of Assets.
A more advanced search may be
performed with getAssetsBySearch().
It accepts an
AssetSearch
in addition to the query for the purpose of specifying
additional options affecting the entire search, such as ordering.
getAssetsBySearch()
returns an AssetSearchResults
that can be used to access the resulting AssetList
or be
used to perform a search within the result set through AssetList.
This session defines views that offer differing behaviors for searching.
Assets may have a query record indicated by their respective record
types. The query record is accessed via the AssetQuery.
Modifier and Type | Method and Description |
---|---|
AssetQuery |
getAssetQueryFromInspector(AssetQueryInspector assetQueryInspector)
Gets an asset query from an inspector.
|
AssetSearchResults |
getAssetsBySearch(AssetQuery assetQuery,
AssetSearch assetSearch)
Gets the search results matching the given search query using the
given search.
|
AssetSearch |
getAssetSearch()
Gets an asset search.
|
AssetSearchOrder |
getAssetSearchOrder()
Gets an asset search order.
|
canSearchAssets, getAssetQuery, getAssetsByQuery, getRepository, getRepositoryId, useFederatedRepositoryView, useIsolatedRepositoryView
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
AssetSearch getAssetSearch()
mandatory
- This method must be implemented. AssetSearchOrder getAssetSearchOrder()
AssetSearchOrder
is
supplied to an AssetSearch
to specify the ordering of
results.mandatory
- This method must be implemented. AssetSearchResults getAssetsBySearch(AssetQuery assetQuery, AssetSearch assetSearch) throws OperationFailedException, PermissionDeniedException
assetQuery
- the asset queryassetSearch
- the asset searchNullArgumentException
- assetQuery
or
assetSearch
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- assetQuery
or
assetSearch
is not of this servicemandatory
- This method must be implemented. AssetQuery getAssetQueryFromInspector(AssetQueryInspector assetQueryInspector)
AssetSearchResults.
assetQueryInspector
- an asset query inspectorNullArgumentException
- assetQueryInspector
is null
UnsupportedException
- assetQueryInspector
is not of this servicemandatory
- This method must be implemented.