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

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

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.

MethodgetRepositoryId
Description

Gets the Repository Id associated with this session.

Returnosid.id.Id the Repository Id associated with this session
Compliancemandatory This method must be implemented.
MethodgetRepository
Description

Gets the Repository associated with this session.

Returnosid.repository.Repository the repository
ErrorsOPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethodcanSearchAssetContents
Description

Tests if this user can perform AssetContent lookups. A return of true does not guarantee successful authorization. A return of false indicates that it is known all methods in this session will result in a PERMISSION_DENIED.This is intended as a hint to an application that may not offer lookup operations to unauthorized users.

Returnboolean false if search methods are not authorized, true otherwise
Compliancemandatory This method must be implemented.
MethoduseFederatedRepositoryView
Description

Federates the view for methods in this session. A federated view will include asset contents in repositories which are children of this repository in the repository hierarchy.

Compliancemandatory This method is must be implemented.
MethoduseIsolatedRepositoryView
Description

Isolates the view for methods in this session. An isolated view restricts searches to this repository only.

Compliancemandatory This method is must be implemented.
MethodgetAssetContentQuery
Description

Gets an asset content query.

Returnosid.repository.AssetContentQuery the asset content query
Compliancemandatory This method must be implemented.
MethodgetAssetContentsByQuery
Description

Gets a list of AssetContents matching the given search.

Parametersosid.repository.AssetContentQueryassetContentQuery the asset content query
Returnosid.repository.AssetContentList the returned AssetContentList
ErrorsNULL_ARGUMENT assetContentQuery is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
UNSUPPORTED assetContentQuery did not originate from getAssetContentQuery()
Compliancemandatory This method must be implemented.