org.osid.repository

Interface AssetSearchSession

All Superinterfaces:

AssetQuerySession, java.lang.AutoCloseable, java.io.Closeable, 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 a 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

Methods

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.

Methods inherited from interface org.osid.repository.AssetQuerySession

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

Methods inherited from interface org.osid.OsidSession

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

Methods inherited from interface org.osid.binding.java.OsidSession

close

Methods inherited from interface java.io.Closeable

close

Method Detail

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.