Interface AssetSearchSession

All Superinterfaces:

AssetQuerySession, AutoCloseable, Closeable, OsidSession, OsidSession

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.

• federated repository view: searches include assets in repositories of which this repository is an ancestor in the repository hierarchy
• isolated repository view: searches are restricted to assets in this repository

Assets may have a query record indicated by their respective record types. The query record is accessed via the AssetQuery .

Method Summary

Modifier and Type	Method	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.

Methods inherited from interface AssetQuerySession

canSearchAssets, getAssetQuery, getAssetsByQuery, getRepository, getRepositoryId, useFederatedRepositoryView, useIsolatedRepositoryView

Modifier and Type	Method	Description
boolean	canSearchAssets()	Tests if this user can perform Asset searches.
AssetQuery	getAssetQuery()	Gets an asset query.
AssetList	getAssetsByQuery(AssetQuery assetQuery)	Gets a list of Assets matching the given asset query.
Repository	getRepository()	Gets the Repository associated with this session.
Id	getRepositoryId()	Gets the Repository Id associated with this session.
void	useFederatedRepositoryView()	Federates the view for methods in this session.
void	useIsolatedRepositoryView()	Isolates the view for methods in this session.

Methods inherited from interface Closeable

close

Methods inherited from interface OsidSession

close

Modifier and Type	Method	Description
void	close()	Close this session.

Methods inherited from interface OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Modifier and Type	Method	Description
Agent	getAuthenticatedAgent()	Gets the agent authenticated to this session.
Id	getAuthenticatedAgentId()	Gets the Id of the agent authenticated to this session.
BigDecimal	getClockRate()	Gets the rate of the service clock.
Date	getDate()	Gets the service date which may be the current date or the effective date in which this session exists.
Agent	getEffectiveAgent()	Gets the effective agent in use by this session.
Id	getEffectiveAgentId()	Gets the Id of the effective agent in use by this session.
Type	getFormatType()	Gets the DisplayText format Type preference in effect for this session.
Locale	getLocale()	Gets the locale indicating the localization preferences in effect for this session.
boolean	isAuthenticated()	Tests if an agent is authenticated to this session.
Transaction	startTransaction()	Starts a new transaction for this sesson.
boolean	supportsTransactions()	Tests for the availability of transactions.

Method Details

getAssetSearch

AssetSearch getAssetSearch()

Gets an asset search.

Returns:

the asset search

Compliance:

mandatory - This method must be implemented.

getAssetSearchOrder

AssetSearchOrder getAssetSearchOrder()

Gets an asset search order. The AssetSearchOrder is supplied to an AssetSearch to specify the ordering of results.

Returns:

the asset search order

Compliance:

mandatory - This method must be implemented.

getAssetsBySearch

AssetSearchResults getAssetsBySearch(AssetQuery assetQuery,
 AssetSearch assetSearch)
                              throws OperationFailedException,
PermissionDeniedException

Gets the search results matching the given search query using the given search.

Parameters:

assetQuery - the asset query

assetSearch - the asset search

Returns:

the asset search results

Throws:

NullArgumentException - assetQuery or assetSearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - assetQuery or assetSearch is not of this service

Compliance:

mandatory - This method must be implemented.

getAssetQueryFromInspector

AssetQuery getAssetQueryFromInspector(AssetQueryInspector assetQueryInspector)

Gets an asset query from an inspector. The inspector is available from a AssetSearchResults .

Parameters:

assetQueryInspector - an asset query inspector

Returns:

the asset query

Throws:

NullArgumentException - assetQueryInspector is null

UnsupportedException - assetQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.