OSID - osid.repository.AssetRepositorySession Service Interface Definition

Interface	osid.repository.AssetRepositorySession
Implements	`osid.OsidSession`
Description	This session provides methods to retrieve `Assets` to `Repository` mappings. An `Asset` may appear in multiple `Repository` objects. Each Repository may have its own authorizations governing who is allowed to look at it. This lookup session defines two views: comparative view: elements may be silently omitted or re-ordered plenary view: provides a complete result set or is an error condition
Method	canLookupAssetRepositoryMappings
Description	Tests if this user can perform lookups of asset/repository mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known lookup 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 looking up mappings is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	useComparativeRepositoryView
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	usePlenaryRepositoryView
Description	A complete view of the `Asset` and `Repository` 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	getAssetIdsByRepository
Description	Gets the list of `Asset` `Ids` associated with a `Repository.`
Parameters	`osid.id.Id`	`repositoryId`	`Id` of the `Repository`
Return	`osid.id.IdList`		list of related asset `Ids`
Errors	NOT_FOUND		`repositoryId` is not found
	NULL_ARGUMENT		`repositoryId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getAssetsByRepository
Description	Gets the list of `Assets` associated with a `Repository.`
Parameters	`osid.id.Id`	`repositoryId`	`Id` of the `Repository`
Return	`osid.repository.AssetList`		list of related assets
Errors	NOT_FOUND		`repositoryId` is not found
	NULL_ARGUMENT		`repositoryId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getAssetIdsByRepositories
Description	Gets the list of `Asset Ids` corresponding to a list of `Repository` objects.
Parameters	`osid.id.IdList`	`repositoryIds`	list of repository `Ids`
Return	`osid.id.IdList`		list of asset `Ids`
Errors	NULL_ARGUMENT		`repositoryIds` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getAssetsByRepositories
Description	Gets the list of `Assets` corresponding to a list of `Repository` objects.
Parameters	`osid.id.IdList`	`repositoryIds`	list of repository `Ids`
Return	`osid.repository.AssetList`		list of assets
Errors	NULL_ARGUMENT		`repositoryIds` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getRepositoryIdsByAsset
Description	Gets the list of `Repository` `Ids` mapped to an `Asset.`
Parameters	`osid.id.Id`	`assetId`	`Id` of an `Asset`
Return	`osid.id.IdList`		list of repository `Ids`
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.
Method	getRepositoriesByAsset
Description	Gets the list of `Repository` objects mapped to an `Asset.`
Parameters	`osid.id.Id`	`assetId`	`Id` of an `Asset`
Return	`osid.repository.RepositoryList`		list of repositories
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.