OSID Logo
OSID Specifications
repository package
Version 3.0.0
Release Candidate Preview
Interfaceosid.repository.AssetSmartRepositorySession
Implementsosid.OsidSession
Description

This session manages queries and sequencing to create "smart" dynamic catalogs. An AssetQuery can be retrieved from this session and mapped to this Repository to create a virtual collection of Assets. The assets may be sequenced using the AssetSearchOrder from this session.

This Repository has a default query that matches any asset and a default search order that specifies no sequencing. The queries may be examined using an AssetQueryInspector. The query may be modified by converting the inspector back to an AssetQuery.

MethodgetRepositoryId
Description

Gets the Repository Id associated with this session.

Returnosid.id.Idthe Repository Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetRepository
Description

Gets the Repository associated with this session.

Returnosid.repository.Repositorythe Repository associated with this session
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanManageSmartRepository
Description

Tests if this user can manage smart repository. 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
CompliancemandatoryThis method must be implemented.
MethodgetAssetQuery
Description

Gets na asset query.

Returnosid.repository.AssetQuerythe asset query
CompliancemandatoryThis method must be implemented.
MethodgetAssetSearchOrder
Description

Gets an asset search order.

Returnosid.repository.AssetSearchOrderthe asset search order
CompliancemandatoryThis method must be implemented.
MethodapplyAssetQuery
Description

Applies an asset query to this repository.

Parametersosid.repository.AssetQueryassetQuerythe asset query
ErrorsNULL_ARGUMENT assetQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED assetQuery not of this service
CompliancemandatoryThis method must be implemented.
MethodinspectAssetQuery
Description

Gets an asset query inspector for this repository.

Returnosid.repository.AssetQueryInspectorthe asset query inspector
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
CompliancemandatoryThis method must be implemented.
MethodapplyAssetSequencing
Description

Applies an asset search order to this repository.

Parametersosid.repository.AssetSearchOrderassetSearchOrderthe asset search order
ErrorsNULL_ARGUMENT assetSearchOrder is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED assetSearchOrder not of this service
CompliancemandatoryThis method must be implemented.
MethodgetAssetQueryFromInspector
Description

Gets an asset query from an inspector.

Parametersosid.repository.AssetQueryInspectorassetQueryInspectora resorce relationship query inspector
Returnosid.repository.AssetQuerythe asset query
ErrorsNULL_ARGUMENT assetQueryInspector is null
UNSUPPORTED assetQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.