public interface AssetCompositionDesignSession extends OsidSession
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.
Modifier and Type | Method and Description |
---|---|
void |
addAsset(Id assetId,
Id compositionId)
Appends an asset to a composition.
|
boolean |
canComposeAssets()
Tests if this user can manage mapping of
Assets to
Compositions. |
Repository |
getRepository()
Gets the
Repository associated with this session. |
Id |
getRepositoryId()
Gets the
Repository Id associated with
this session. |
void |
moveAssetAhead(Id assetId,
Id compositionId,
Id referenceId)
Reorders assets in a composition by moving the specified asset in
front of a reference asset.
|
void |
moveAssetBehind(Id assetId,
Id compositionId,
Id referenceId)
Reorders assets in a composition by moving the specified asset behind
of a reference asset.
|
void |
orderAssets(Id[] assetIds,
Id compositionId)
Reorders a set of assets in a composition.
|
void |
removeAsset(Id assetId,
Id compositionId)
Removes an
Asset from a Composition. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getRepositoryId()
Repository
Id
associated with
this session. Repository Id
associated with this sessionmandatory
- This method must be implemented. Repository getRepository() throws OperationFailedException, PermissionDeniedException
Repository
associated with this session. Repository
associated with this sessionOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canComposeAssets()
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. false
if asset composiion is not authorized,
true
otherwisemandatory
- This method must be implemented. void addAsset(Id assetId, Id compositionId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
assetId
- Id
of the Asset
compositionId
- Id
of the Composition
AlreadyExistsException
- assetId
already
part compositionId
NotFoundException
- assetId
or
compositionId
not foundNullArgumentException
- assetId
or
compositionId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization fauiluremandatory
- This method must be implemented. void moveAssetAhead(Id assetId, Id compositionId, Id referenceId) throws NotFoundException, OperationFailedException, PermissionDeniedException
assetId
- Id
of the Asset
compositionId
- Id
of the Composition
referenceId
- Id
of the reference Asset
NotFoundException
- assetId
or
referenceId
not found in compositionId
NullArgumentException
- assetId, referenceId
or compositionId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization fauiluremandatory
- This method must be implemented. void moveAssetBehind(Id assetId, Id compositionId, Id referenceId) throws NotFoundException, OperationFailedException, PermissionDeniedException
assetId
- Id
of the Asset
compositionId
- Id
of the Composition
referenceId
- Id
of the reference Asset
NotFoundException
- assetId
or
referenceId
not found in compositionId
NullArgumentException
- assetId, referenceId
or compositionId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization fauiluremandatory
- This method must be implemented. void orderAssets(Id[] assetIds, Id compositionId) throws NotFoundException, OperationFailedException, PermissionDeniedException
assetIds
- Ids
for a set of Assets
compositionId
- Id
of the Composition
NotFoundException
- compositionId
not
found or, an assetId
not related to
compositionId
NullArgumentException
- instructionIds
or agendaId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void removeAsset(Id assetId, Id compositionId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Asset
from a Composition.
assetId
- Id
of the Asset
compositionId
- Id
of the Composition
NotFoundException
- assetId
not
found in compositionId
NullArgumentException
- assetId
or
compositionId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization fauiluremandatory
- This method must be implemented.