OSID - osid.repository.AssetLookupSession Service Interface Definition

Interface	osid.repository.AssetLookupSession
Implements	`osid.OsidSession`
Description	This session defines methods for retrieving assets. An `Asset` represents an element of content stored in a Repository. 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 asset methods in this session operate, retrieve and pertain to assets defined explicitly in the current repository. Using an isolated view is useful for managing `Assets` with the `AssetAdminSession.` federated repository view: All asset methods in this session operate, retrieve and pertain to all assets defined in this repository and any other assets implicitly available in this repository through repository inheritence. The methods `useFederatedRepositoryView()` and `useIsolatedRepositoryView()` behave as a radio group and one should be selected before invoking any lookup methods. Assets may have an additional records indicated by their respective record types. The record may not be accessed through a cast of the `Asset.`
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	canLookupAssets
Description	Tests if this user can perform `Asset` 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.
Return	`boolean`		`false` if lookup methods are not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	useComparativeAssetView
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	usePlenaryAssetView
Description	A complete view of the `Asset` 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 assets 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	getAsset
Description	Gets the `Asset` specified by its `Id.` In plenary mode, the exact `Id` is found or a `NOT_FOUND` results. Otherwise, the returned `Asset` may have a different `Id` than requested, such as the case where a duplicate `Id` was assigned to an `Asset` and retained for compatibility.
Parameters	`osid.id.Id`	`assetId`	the `Id` of the `Asset` to retrieve
Return	`osid.repository.Asset`		the returned `Asset`
Errors	NOT_FOUND		no `Asset` found with the given `Id`
	NULL_ARGUMENT		`assetId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getAssetsByIds
Description	Gets an `AssetList` corresponding to the given `IdList.` In plenary mode, the returned list contains all of the assets specified in the `Id` list, in the order of the list, including duplicates, or an error results if an `Id` in the supplied list is not found or inaccessible. Otherwise, inaccessible `Assets` may be omitted from the list and may present the elements in any order including returning a unique set.
Parameters	`osid.id.IdList`	`assetIds`	the list of `Ids` to retrieve
Return	`osid.repository.AssetList`		the returned `Asset list`
Errors	NOT_FOUND		an `Id` was not found
	NULL_ARGUMENT		`assetIds` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getAssetsByGenusType
Description	Gets an `AssetList` corresponding to the given asset genus `Type` which does not include assets of types derived from the specified `Type.` 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.type.Type`	`assetGenusType`	an asset genus type
Return	`osid.repository.AssetList`		the returned `Asset list`
Errors	NULL_ARGUMENT		`assetGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getAssetsByParentGenusType
Description	Gets an `AssetList` corresponding to the given asset genus `Type` and include any additional assets with genus types derived from the specified `Type.` 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.type.Type`	`assetGenusType`	an asset genus type
Return	`osid.repository.AssetList`		the returned `Asset list`
Errors	NULL_ARGUMENT		`assetGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getAssetsByRecordType
Description	Gets an `AssetList` containing the given asset record `Type.` 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.type.Type`	`assetRecordType`	an asset record type
Return	`osid.repository.AssetList`		the returned `Asset list`
Errors	NULL_ARGUMENT		`assetRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getAssetsByProvider
Description	Gets an `AssetList` from the given provider. 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`	`resourceId`	a resource `Id`
Return	`osid.repository.AssetList`		the returned `Asset list`
Errors	NULL_ARGUMENT		`resourceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getAssets
Description	Gets all `Assets.` 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.
Return	`osid.repository.AssetList`		a list of `Assets`
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.