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

This session manages queries and sequencing to create "smart" dynamic catalogs. An AssetContentQuery can be retrieved from this session and mapped to this Repository to create a virtual collection of AssetContents. The asset contents may be sequenced using the AssetContentSearchOrder from this session.

This Repository has a default query that matches any asset content and a default search order that specifies no sequencing. The queries may be examined using an AssetContentQueryInspector. The query may be modified by converting the inspector back to an 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.
MethodcanManageSmartRepositories
Description

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

Returnboolean false if smart repository management is not authorized, true otherwise
Compliancemandatory This method must be implemented.
MethodgetAssetContentQuery
Description

Gets an asset content query.

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

Gets an asset content search order.

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

Applies an asset content query to this repository.

Parametersosid.repository.AssetContentQueryassetContentQuery the asset content query
ErrorsNULL_ARGUMENT assetContentQuery is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure occurred
UNSUPPORTED assetContentQuery not of this service
Compliancemandatory This method must be implemented.
MethodinspectAssetContentQuery
Description

Gets an asset content query inspector for this repository.

Returnosid.repository.AssetContentQueryInspector the asset content query inspector
ErrorsOPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure occurred
Compliancemandatory This method must be implemented.
MethodapplyAssetContentSequencing
Description

Applies an asset content search order to this repository.

Parametersosid.repository.AssetContentSearchOrderassetContentSearchOrder the asset content search order
ErrorsNULL_ARGUMENT assetContentSearchOrder is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure occurred
UNSUPPORTED assetContentSearchOrder not of this service
Compliancemandatory This method must be implemented.
MethodgetAssetContentQueryFromInspector
Description

Gets an asset content query from an inspector.

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.