Interface | osid.repository.AssetCompositionDesignSession | ||
---|---|---|---|
Implements | osid.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 | ||
Method | getRepositoryId | ||
Description |
Gets the | ||
Return | osid.id.Id | the Repository Id associated with this session | |
Compliance | mandatory | This method must be implemented. | |
Method | getRepository | ||
Description |
Gets the | ||
Return | osid.repository.Repository | the Repository associated with this session | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canComposeAssets | ||
Description |
Tests if this user can manage mapping of | ||
Return | boolean | false if asset composiion is not authorized, true
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | addAsset | ||
Description |
Appends an asset to a composition. | ||
Parameters | osid.id.Id | assetId | Id of the Asset |
osid.id.Id | compositionId | Id of the Composition | |
Errors | ALREADY_EXISTS | assetId already part compositionId | |
NOT_FOUND | assetId or compositionId not found | ||
NULL_ARGUMENT | assetId or compositionId is null
| ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization fauilure | ||
Compliance | mandatory | This method must be implemented. | |
Method | moveAssetAhead | ||
Description |
Reorders assets in a composition by moving the specified asset in front of a reference asset. | ||
Parameters | osid.id.Id | assetId | Id of the Asset |
osid.id.Id | compositionId | Id of the Composition | |
osid.id.Id | referenceId | Id of the reference Asset | |
Errors | NOT_FOUND | assetId or referenceId not found in
compositionId | |
NULL_ARGUMENT | assetId, referenceId or compositionId is
null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization fauilure | ||
Compliance | mandatory | This method must be implemented. | |
Method | moveAssetBehind | ||
Description |
Reorders assets in a composition by moving the specified asset behind of a reference asset. | ||
Parameters | osid.id.Id | assetId | Id of the Asset |
osid.id.Id | compositionId | Id of the Composition | |
osid.id.Id | referenceId | Id of the reference Asset | |
Errors | NOT_FOUND | assetId or referenceId not found in
compositionId | |
NULL_ARGUMENT | assetId, referenceId or compositionId is
null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization fauilure | ||
Compliance | mandatory | This method must be implemented. | |
Method | orderAssets | ||
Description |
Reorders a set of assets in a composition. | ||
Parameters | osid.id.Id[] | assetIds | Ids for a set of Assets |
osid.id.Id | compositionId | Id of the Composition | |
Errors | NOT_FOUND | compositionId not found or, an assetId not
related to compositionId | |
NULL_ARGUMENT | instructionIds or agendaId is null
| ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | removeAsset | ||
Description |
Removes an | ||
Parameters | osid.id.Id | assetId | Id of the Asset |
osid.id.Id | compositionId | Id of the Composition | |
Errors | NOT_FOUND | assetId not found in compositionId | |
NULL_ARGUMENT | assetId or compositionId is null
| ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization fauilure | ||
Compliance | mandatory | This method must be implemented. |