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

This session provides the means for adding assets to an asset composiiton. The asset is identified inside a composition using its own Id. To add the same asset to the composition, multiple compositions should be used and placed at the same level in the Composition hierarchy.

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

Tests if this user can manage mapping of Assets to Compositions. 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 an application hint that may opt not to offer composition operations.

Returnboolean false if asset composiion is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodaddAsset
Description

Appends an asset to a composition.

Parametersosid.id.IdassetId Id of the Asset
osid.id.IdcompositionId Id of the Composition
ErrorsALREADY_EXISTS assetId already part compositionId
NOT_FOUND assetId or compositionId not found
NULL_ARGUMENT assetId or compositionId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization fauilure
CompliancemandatoryThis method must be implemented.
MethodmoveAssetAhead
Description

Reorders assets in a composition by moving the specified asset in front of a reference asset.

Parametersosid.id.IdassetId Id of the Asset
osid.id.IdcompositionId Id of the Composition
osid.id.IdreferenceId Id of the reference Asset
ErrorsNOT_FOUND assetId or referenceId not found in compositionId
NULL_ARGUMENT assetId, referenceId or compositionId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization fauilure
CompliancemandatoryThis method must be implemented.
MethodmoveAssetBehind
Description

Reorders assets in a composition by moving the specified asset behind of a reference asset.

Parametersosid.id.IdassetId Id of the Asset
osid.id.IdcompositionId Id of the Composition
osid.id.IdreferenceId Id of the reference Asset
ErrorsNOT_FOUND assetId or referenceId not found in compositionId
NULL_ARGUMENT assetId, referenceId or compositionId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization fauilure
CompliancemandatoryThis method must be implemented.
MethodorderAssets
Description

Reorders a set of assets in a composition.

Parametersosid.id.Id[]assetIds Ids for a set of Assets
osid.id.IdcompositionId Id of the Composition
ErrorsNOT_FOUND compositionId not found or, an assetId not related to compositionId
NULL_ARGUMENT instructionIds or agendaId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodremoveAsset
Description

Removes an Asset from a Composition.

Parametersosid.id.IdassetId Id of the Asset
osid.id.IdcompositionId Id of the Composition
ErrorsNOT_FOUND assetId not found in compositionId
NULL_ARGUMENT assetId or compositionId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization fauilure
CompliancemandatoryThis method must be implemented.