OSID - osid.repository.AssetQuerySession Service Interface Definition

Interface	osid.repository.AssetQuerySession
Implements	`osid.OsidSession`
Description	This session provides methods for searching among `Asset` objects. The search query is constructed using the `AssetQuery.` This session defines views that offer differing behaviors for searching. federated repository view: searches include assets in repositories of which this repository is a ancestor in the repository hierarchy isolated repository view: searches are restricted to assets in this repository Assets may have a query record indicated by their respective record types. The query record is accessed via the `AssetQuery.`
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	canSearchAssets
Description	Tests if this user can perform `Asset` searches. 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 search operations to unauthorized users.
Return	`boolean`		`false` if search methods are not authorized, `true` otherwise
Compliance	`mandatory`		This method 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	getAssetQuery
Description	Gets an asset query.
Return	`osid.repository.AssetQuery`		the asset query
Compliance	`mandatory`		This method must be implemented.
Method	getAssetsByQuery
Description	Gets a list of `Assets` matching the given asset query.
Parameters	`osid.repository.AssetQuery`	`assetQuery`	the asset query
Return	`osid.repository.AssetList`		the returned `AssetList`
Errors	NULL_ARGUMENT		`assetQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		the `assetQuery` is not of this service
Compliance	`mandatory`		This method must be implemented.