OSID Logo
OSID Specifications
repository package
Version 3.1.0
Interfaceosid.repository.AssetContentSearchSession
Implementsosid.repository.AssetContentQuerySession
Used Byosid.repository.RepositoryManager
osid.repository.RepositoryProxyManager
Description

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.

MethodgetAssetContentSearch
Description

Gets an asset content search.

Returnosid.repository.AssetContentSearch the asset content search
Compliancemandatory This method must be implemented.
MethodgetAssetContentSearchOrder
Description

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

Returnosid.repository.AssetContentSearchOrder the asset content search order
Compliancemandatory This method must be implemented.
MethodgetAssetContentsBySearch
Description

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

Parametersosid.repository.AssetContentQueryassetContentQuery the asset content query
osid.repository.AssetContentSearchassetContentSearch the asset content search
Returnosid.repository.AssetContentSearchResults the returned search results
ErrorsNULL_ARGUMENT assetContentQuery or assetContentSearch is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
UNSUPPORTED assetContentQuery or assetContentSearch is not of this service
Compliancemandatory This method must be implemented.
MethodgetAssetContentQueryFromInspector
Description

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

Parametersosid.repository.AssetContentQueryInspectorassetContentQueryInspector an asset content query inspector
Returnosid.repository.AssetContentQuery the asset content query
ErrorsNULL_ARGUMENT assetContentQueryInspector is null
UNSUPPORTED assetContentQueryInspector is not of this service
Compliancemandatory This method must be implemented.