OSID - osid.repository.AssetCompositionSession Service Interface Definition

Interface	osid.repository.AssetCompositionSession
Implements	`osid.OsidSession`
Description	This session defines methods for looking up `Asset` to `Composition` mappings. A `Composition` represents a collection of `Assets.` This lookup session defines several views: comparative view: elements may be silently omitted or re-ordered plenary view: provides a complete result set or is an error condition isolated repository view: All lookup methods in this session operate, retrieve and pertain to asseta and compositions defined explicitly in the current repository. Using an isolated view is useful for managing compositions with the CompositionAdminSession. federated repository view: All lookup methods in this session operate, retrieve and pertain to all compositions and assets defined in this repository and any other compositions implicitly available in this repository through repository inheritence. The methods `useFederatedAssetCompositionView()` and `useIsolatedAssetCompositiontView()` behave as a radio group and one should be selected before invoking any lookup methods.
Method	getRepositoryId
Description	Gets the `Repository` `Id` associated with this session.
Return	`osid.id.Id`		the `Repository Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getRepository
Description	Gets the `Repository` associated with this session.
Return	`osid.repository.Repository`		the `Repository` associated with this session
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canAccessAssetCompositions
Description	Tests if this user can perform composition lookups. 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 a hint to an application that may opt not to offer lookup operations to unauthorized users.
Return	`boolean`		`false` if lookup methods are not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	useComparativeAssetCompositionView
Description	The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision.
Compliance	`mandatory`		This method is must be implemented.
Method	usePlenaryAssetCompositionView
Description	A complete view of the returns is desired. Methods will return what is requested or result in an error. This view is used when greater precision is desired at the expense of interoperability.
Compliance	`mandatory`		This method is must be implemented.
Method	useFederatedRepositoryView
Description	Federates the view for methods in this session. A federated view will include compositions in repositories which are children of this repository in the repository hierarchy.
Compliance	`mandatory`		This method is must be implemented.
Method	useIsolatedRepositoryView
Description	Isolates the view for methods in this session. An isolated view restricts lookups to this repository only.
Compliance	`mandatory`		This method is must be implemented.
Method	getCompositionAssets
Description	Gets the list of assets mapped to the given `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.
Parameters	`osid.id.Id`	`compositionId`	`Id` of the `Composition`
Return	`osid.repository.AssetList`		list of assets
Errors	NOT_FOUND		`compositionId` not found
	NULL_ARGUMENT		`compositionId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method is must be implemented.
Method	getCompositionsByAsset
Description	Gets a list of compositions including the given asset. 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.
Parameters	`osid.id.Id`	`assetId`	`Id` of the `Asset`
Return	`osid.repository.CompositionList`		the returned `Composition list`
Errors	NOT_FOUND		`assetId` is not found
	NULL_ARGUMENT		`assetId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.