OSID - osid.repository.AssetContentLookupSession Service Interface Definition

Interface	osid.repository.AssetContentLookupSession
Implements	`osid.OsidSession`
Used By	`osid.repository.RepositoryManager`
Used By	`osid.repository.RepositoryProxyManager`
Description	This session provides methods for retrieving `AssetContents`. This session defines views that offer differing behaviors when retrieving multiple objects. comparative view: elements may be silently omitted or re-ordered plenary view: provides a complete set or is an error condition isolated repository view: All asset content methods in this session operate, retrieve and pertain to asset contents defined explicitly in the current repository Using an isolated view is useful for managing `AssetContents` with the `AssetContentAdminSession`. federated asset content view: All asset content methods in this session operate, retrieve and pertain to all asset contents defined in this repository and any other asset contents implicitly available in this repository through repository inheritence. Generally, the comparative view should be used for most applications as it permits operation even if there is data that cannot be accessed. The methods `useFederatedRepositoryView()` and `useIsolatedRepositoryView() beh` ave 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
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canLookupAssetContents
Description	Tests if this user can perform `AssetContent` 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	useComparativeAssetContentView
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	usePlenaryAssetContentView
Description	A complete view of the `AssetContent` 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 asset contents 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	getAssetContent
Description	Gets the `AssetContent` specified by its `Id`. In plenary mode, the exact Id is found or a `NOT_FOUND` results. Otherwise, the returned `AssetContent` may have a different `Id` than requested, such as the case where a duplicate `Id` was assigned to an `AssetContent a` nd retained for compatibility.
Parameters	`osid.id.Id`	`assetContentId`	`Id` of the `AssetContent`
Return	`osid.repository.AssetContent`		the asset content
Errors	NOT_FOUND		`assetContentId` not found
	NULL_ARGUMENT		`assetContentId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method is must be implemented.
Method	getAssetContentsByIds
Description	Gets an `AssetContentList` corresponding to the given `IdList`. In plenary mode, the returned list contains all of the asset contents 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 `AssetContents may` be omitted from the list and may present the elements in any order including returning a unique set.
Parameters	`osid.id.IdList`	`assetContentIds`	the list of `Ids` to retrieve
Return	`osid.repository.AssetContentList`		the returned `AssetContent` list
Errors	NOT_FOUND		an `Id was` not found
	NULL_ARGUMENT		`assetContentIds` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getAssetContentsByGenusType
Description	Gets an `AssetContentList` corresponding to the given asset content genus `Type` which does not include asset contents of genus types derived from the specified `Type`. `In p` lenary mode, the returned list contains all known asset contents or an error results. Otherwise, the returned list may contain only those asset contents that are accessible through this session.
Parameters	`osid.type.Type`	`assetContentGenusType`	an asset content genus type
Return	`osid.repository.AssetContentList`		the returned `AssetContent` list
Errors	NULL_ARGUMENT		`assetContentGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getAssetContentsByParentGenusType
Description	Gets an `AssetContentList` corresponding to the given asset content genus `Type` and include any additional asset contents with genus types derived from the specified `Type`. `In p` lenary mode, the returned list contains all known asset contents or an error results. Otherwise, the returned list may contain only those asset contents that are accessible through this session.
Parameters	`osid.type.Type`	`assetContentGenusType`	an asset content genus type
Return	`osid.repository.AssetContentList`		the returned `AssetContent` list
Errors	NULL_ARGUMENT		`assetContentGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getAssetContentsByRecordType
Description	Gets an `AssetContentList` containing the given asset content record `Type`. `In p` lenary mode, the returned list contains all known asset contents or an error results. Otherwise, the returned list may contain only those asset contents that are accessible through this session.
Parameters	`osid.type.Type`	`assetContentRecordType`	an asset content record type
Return	`osid.repository.AssetContentList`		the returned `AssetContent` list
Errors	NULL_ARGUMENT		`assetContentRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getAssetContentsForAsset
Description	Gets an `AssetContentList` for the given asset. `In p` lenary mode, the returned list contains all known asset contents or an error results. Otherwise, the returned list may contain only those asset contents that are accessible through this session.
Parameters	`osid.id.Id`	`assetId`	an asset `Id`
Return	`osid.repository.AssetContentList`		the returned `AssetContent` list
Errors	NULL_ARGUMENT		`assetId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getAssetContents
Description	Gets all `AssetContents`. In plenary mode, the returned list contains all known asset contents or an error results. Otherwise, the returned list may contain only those asset contents that are accessible through this session.
Return	`osid.repository.AssetContentList`		a list of `AssetContents`
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.