public interface AssetCompositionSession extends OsidSession
This session defines methods for looking up Asset
to
Composition
mappings. A Composition
represents a collection of Assets.
This lookup session defines several views:
The methods useFederatedAssetCompositionView()
and
useIsolatedAssetCompositiontView()
behave as a radio group
and one should be selected before invoking any lookup methods.
Modifier and Type | Method and Description |
---|---|
boolean |
canAccessAssetCompositions()
Tests if this user can perform composition lookups.
|
AssetList |
getCompositionAssets(Id compositionId)
Gets the list of assets mapped to the given
Composition. |
CompositionList |
getCompositionsByAsset(Id assetId)
Gets a list of compositions including the given asset.
|
Repository |
getRepository()
Gets the
Repository associated with this session. |
Id |
getRepositoryId()
Gets the
Repository Id associated with
this session. |
void |
useComparativeAssetCompositionView()
The returns from the lookup methods may omit or translate elements
based on this session, such as authorization, and not result in an
error.
|
void |
useFederatedRepositoryView()
Federates the view for methods in this session.
|
void |
useIsolatedRepositoryView()
Isolates the view for methods in this session.
|
void |
usePlenaryAssetCompositionView()
A complete view of the returns is desired.
|
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 canAccessAssetCompositions()
PERMISSION_DENIED.
This is intended as a hint to an
application that may opt not to offer lookup operations to
unauthorized users. false
if lookup methods are not authorized,
true
otherwisemandatory
- This method must be implemented. void useComparativeAssetCompositionView()
mandatory
- This method is must be implemented. void usePlenaryAssetCompositionView()
mandatory
- This method is must be implemented. void useFederatedRepositoryView()
mandatory
- This method is must be implemented. void useIsolatedRepositoryView()
mandatory
- This method is must be implemented. AssetList getCompositionAssets(Id compositionId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Composition.
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.compositionId
- Id
of the Composition
NotFoundException
- compositionId
not
foundNullArgumentException
- compositionId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method is must be implemented. CompositionList getCompositionsByAsset(Id assetId) throws NotFoundException, OperationFailedException, PermissionDeniedException
In plenary mode, the returned list contains all known compositions or
an error results. Otherwise, the returned list may contain only those
compositions that are accessible through this session.assetId
- Id
of the Asset
Composition list
NotFoundException
- assetId
is not foundNullArgumentException
- assetId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.