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

This session defines methods for retrieving assets. An Asset represents an element of content stored in a Repository.

This lookup session defines several views:

  • comparative view: elements may be silently omitted or re-ordered
  • plenary view: provides a complete result set or is an error condition
  • isolated repository view: All asset methods in this session operate, retrieve and pertain to assets defined explicitly in the current repository. Using an isolated view is useful for managing Assets with the AssetAdminSession.
  • federated repository view: All asset methods in this session operate, retrieve and pertain to all assets defined in this repository and any other assets implicitly available in this repository through repository inheritence.

The methods useFederatedRepositoryView() and useIsolatedRepositoryView() behave as a radio group and one should be selected before invoking any lookup methods.

Assets may have an additional records indicated by their respective record types. The record may not be accessed through a cast of the Asset.

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.
MethodcanLookupAssets
Description

Tests if this user can perform Asset 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 opt not to offer lookup operations.

Returnboolean false if lookup methods are not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoduseComparativeAssetView
Description

The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision.

CompliancemandatoryThis method is must be implemented.
MethodusePlenaryAssetView
Description

A complete view of the Asset returns is desired. Methods will return what is requested or result in an error. This view is used when greater precision is desired at the expense of interoperability.

CompliancemandatoryThis method is must be implemented.
MethoduseFederatedRepositoryView
Description

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

CompliancemandatoryThis method is must be implemented.
MethoduseIsolatedRepositoryView
Description

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

CompliancemandatoryThis method is must be implemented.
MethodgetAsset
Description

Gets the Asset specified by its Id. In plenary mode, the exact Id is found or a NOT_FOUND results. Otherwise, the returned Asset may have a different Id than requested, such as the case where a duplicate Id was assigned to an Asset and retained for compatibility.

Parametersosid.id.IdassetIdthe Id of the Asset to retrieve
Returnosid.repository.Assetthe returned Asset
ErrorsNOT_FOUNDno Asset found with the given Id
NULL_ARGUMENT assetId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetAssetsByIds
Description

Gets an AssetList corresponding to the given IdList. In plenary mode, the returned list contains all of the assets specified in the Id list, in the order of the list, including duplicates, or an error results if an Id in the supplied list is not found or inaccessible. Otherwise, inaccessible Assets may be omitted from the list and may present the elements in any order including returning a unique set.

Parametersosid.id.IdListassetIdsthe list of Ids to retrieve
Returnosid.repository.AssetListthe returned Asset list
ErrorsNOT_FOUNDan Id was not found
NULL_ARGUMENT assetIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetAssetsByGenusType
Description

Gets an AssetList corresponding to the given asset genus Type which does not include assets of types derived from the specified Type. In plenary mode, the returned list contains all known assets or an error results. Otherwise, the returned list may contain only those assets that are accessible through this session.

Parametersosid.type.TypeassetGenusTypean asset genus type
Returnosid.repository.AssetListthe returned Asset list
ErrorsNULL_ARGUMENT assetGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetAssetsByParentGenusType
Description

Gets an AssetList corresponding to the given asset genus Type and include any additional assets with genus types derived from the specified Type. In plenary mode, the returned list contains all known assets or an error results. Otherwise, the returned list may contain only those assets that are accessible through this session.

Parametersosid.type.TypeassetGenusTypean asset genus type
Returnosid.repository.AssetListthe returned Asset list
ErrorsNULL_ARGUMENT assetGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetAssetsByRecordType
Description

Gets an AssetList containing the given asset record Type. In plenary mode, the returned list contains all known assets or an error results. Otherwise, the returned list may contain only those assets that are accessible through this session.

Parametersosid.type.TypeassetRecordTypean asset record type
Returnosid.repository.AssetListthe returned Asset list
ErrorsNULL_ARGUMENT assetRecordType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetAssetsByProvider
Description

Gets an AssetList from the given provider. In plenary mode, the returned list contains all known assets or an error results. Otherwise, the returned list may contain only those assets that are accessible through this session.

Parametersosid.id.IdresourceIda resource Id
Returnosid.repository.AssetListthe returned Asset list
ErrorsNULL_ARGUMENT resourceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetAssets
Description

Gets all Assets. In plenary mode, the returned list contains all known assets or an error results. Otherwise, the returned list may contain only those assets that are accessible through this session.

Returnosid.repository.AssetLista list of Assets
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.