Interface AssetContentSearchSession

All Superinterfaces:

AssetContentQuerySession, AutoCloseable, Closeable, OsidSession, OsidSession

public interface AssetContentSearchSession
extends AssetContentQuerySession

This session provides methods for searching among AssetContents . The search query is constructed using the AssetContentQuery .

getAssetContentsByQuery() is the basic search method and returns a list of AssetContents . A more advanced search may be performed with getAssetContentsBySearch() .It accepts an AssetContentSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getAssetContentsBySearch() returns an AssetContentSearchResults that can be used to access the resulting AssetContentList or be used to perform a search within the result set through AssetContentSearch .

This session defines views that offer differing behaviors for searching.

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

Asset Contents may have a query record indicated by their respective record types. The query record is accessed via the AssetContentQuery .

Method Summary

Modifier and Type	Method	Description
AssetContentQuery	getAssetContentQueryFromInspector(AssetContentQueryInspector assetContentQueryInspector)	Gets an asset content query from an inspector.
AssetContentSearchResults	getAssetContentsBySearch(AssetContentQuery assetContentQuery, AssetContentSearch assetContentSearch)	Gets the search results matching the given search query using the given search.
AssetContentSearch	getAssetContentSearch()	Gets an asset content search.
AssetContentSearchOrder	getAssetContentSearchOrder()	Gets an asset content search order.

Methods inherited from interface AssetContentQuerySession

canSearchAssetContents, getAssetContentQuery, getAssetContentsByQuery, getRepository, getRepositoryId, useFederatedRepositoryView, useIsolatedRepositoryView

Modifier and Type	Method	Description
boolean	canSearchAssetContents()	Tests if this user can perform AssetContent lookups.
AssetContentQuery	getAssetContentQuery()	Gets an asset content query.
AssetContentList	getAssetContentsByQuery(AssetContentQuery assetContentQuery)	Gets a list of AssetContents matching the given search.
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

getAssetContentSearch

AssetContentSearch getAssetContentSearch()

Gets an asset content search.

Returns:

the asset content search

Compliance:

mandatory - This method must be implemented.

getAssetContentSearchOrder

AssetContentSearchOrder getAssetContentSearchOrder()

Gets an asset content search order. The AssetContentSearchOrder is supplied to an AssetContentSearch to specify the ordering of results.

Returns:

the asset content search order

Compliance:

mandatory - This method must be implemented.

getAssetContentsBySearch

AssetContentSearchResults getAssetContentsBySearch(AssetContentQuery assetContentQuery,
 AssetContentSearch assetContentSearch)
                                            throws OperationFailedException,
PermissionDeniedException

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

Parameters:

assetContentQuery - the asset content query

assetContentSearch - the asset content search

Returns:

the returned search results

Throws:

NullArgumentException - assetContentQuery or assetContentSearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - assetContentQuery or assetContentSearch is not of this service

Compliance:

mandatory - This method must be implemented.

getAssetContentQueryFromInspector

AssetContentQuery getAssetContentQueryFromInspector(AssetContentQueryInspector assetContentQueryInspector)

Gets an asset content query from an inspector. The inspector is available from an AssetContentSearchResults .

Parameters:

assetContentQueryInspector - an asset content query inspector

Returns:

the asset content query

Throws:

NullArgumentException - assetContentQueryInspector is null

UnsupportedException - assetContentQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.