Interface AssetCompositionDesignSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface AssetCompositionDesignSession
extends OsidSession

This session provides the means for adding assets to an asset composition. 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.

Method Summary

Modifier and Type	Method	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 .

Methods inherited from interface Closeable

close

Methods inherited from interface OsidSession

close

Modifier and Type	Method	Description
void	close()	Close this session.

Methods inherited from interface OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Modifier and Type	Method	Description
Agent	getAuthenticatedAgent()	Gets the agent authenticated to this session.
Id	getAuthenticatedAgentId()	Gets the Id of the agent authenticated to this session.
BigDecimal	getClockRate()	Gets the rate of the service clock.
Date	getDate()	Gets the service date which may be the current date or the effective date in which this session exists.
Agent	getEffectiveAgent()	Gets the effective agent in use by this session.
Id	getEffectiveAgentId()	Gets the Id of the effective agent in use by this session.
Type	getFormatType()	Gets the DisplayText format Type preference in effect for this session.
Locale	getLocale()	Gets the locale indicating the localization preferences in effect for this session.
boolean	isAuthenticated()	Tests if an agent is authenticated to this session.
Transaction	startTransaction()	Starts a new transaction for this sesson.
boolean	supportsTransactions()	Tests for the availability of transactions.

Method Details

getRepositoryId

Id getRepositoryId()

Gets the Repository Id associated with this session.

Returns:

the Repository Id associated with this session

Compliance:

mandatory - This method must be implemented.

getRepository

Repository getRepository()
                  throws OperationFailedException,
PermissionDeniedException

Gets the Repository associated with this session.

Returns:

the Repository associated with this session

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canComposeAssets

boolean canComposeAssets()

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.

Returns:

false if asset composiion is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

addAsset

void addAsset(Id assetId,
 Id compositionId)
       throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

Appends an asset to a composition.

Parameters:

assetId - Id of the Asset

compositionId - Id of the Composition

Throws:

AlreadyExistsException - assetId already part compositionId

NotFoundException - assetId or compositionId not found

NullArgumentException - assetId or compositionId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization fauilure

Compliance:

mandatory - This method must be implemented.

moveAssetAhead

void moveAssetAhead(Id assetId,
 Id compositionId,
 Id referenceId)
             throws NotFoundException,
OperationFailedException,
PermissionDeniedException

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

Parameters:

assetId - Id of the Asset

compositionId - Id of the Composition

referenceId - Id of the reference Asset

Throws:

NotFoundException - assetId or referenceId not found in compositionId

NullArgumentException - assetId, referenceId or compositionId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization fauilure

Compliance:

mandatory - This method must be implemented.

moveAssetBehind

void moveAssetBehind(Id assetId,
 Id compositionId,
 Id referenceId)
              throws NotFoundException,
OperationFailedException,
PermissionDeniedException

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

Parameters:

assetId - Id of the Asset

compositionId - Id of the Composition

referenceId - Id of the reference Asset

Throws:

NotFoundException - assetId or referenceId not found in compositionId

NullArgumentException - assetId, referenceId or compositionId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization fauilure

Compliance:

mandatory - This method must be implemented.

orderAssets

void orderAssets(Id[] assetIds,
 Id compositionId)
          throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Reorders a set of assets in a composition.

Parameters:

assetIds - Ids for a set of Assets

compositionId - Id of the Composition

Throws:

NotFoundException - compositionId not found or, an assetId not related to compositionId

NullArgumentException - instructionIds or agendaId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

removeAsset

void removeAsset(Id assetId,
 Id compositionId)
          throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes an Asset from a Composition .

Parameters:

assetId - Id of the Asset

compositionId - Id of the Composition

Throws:

NotFoundException - assetId not found in compositionId

NullArgumentException - assetId or compositionId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization fauilure

Compliance:

mandatory - This method must be implemented.