OSID - osid.resource.ResourceQuerySession Service Interface Definition

Interface	osid.resource.ResourceQuerySession
Implements	`osid.OsidSession`
Implemented By	`osid.resource.ResourceSearchSession`
Used By	`osid.resource.ResourceManager`
Used By	`osid.resource.ResourceProxyManager`
Description	This session provides methods for searching among `Resource` objects. The search query is constructed using the `ResourceQuery`. This session defines views that offer differing behaviors for searching. federated bin view: searches include resources in bins of which this bin is an ancestor in the bin hierarchy isolated bin view: searches are restricted to resources in this bin Resources may have a resource record indicated by their respective record types. The resource query record is accessed via the `ResourceQuery`.
Method	getBinId
Description	Gets the `Bin` `Id` associated with this session.
Return	`osid.id.Id`		the `Bin Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getBin
Description	Gets the `Bin` associated with this session.
Return	`osid.resource.Bin`		the `Bin` associated with this session
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canSearchResources
Description	Tests if this user can perform `Resource` 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	useFederatedBinView
Description	Federates the view for methods in this session. A federated view will include resources in bins which are children of this bin in the bin hierarchy.
Compliance	`mandatory`		This method is must be implemented.
Method	useIsolatedBinView
Description	Isolates the view for methods in this session. An isolated view restricts lookups to this bin only.
Compliance	`mandatory`		This method is must be implemented.
Method	getResourceQuery
Description	Gets a resource query. The returned query will not have an extension query.
Return	`osid.resource.ResourceQuery`		the resource query
Compliance	`mandatory`		This method must be implemented.
Method	getResourcesByQuery
Description	Gets a list of `Resources` matching the given resource query.
Parameters	`osid.resource.ResourceQuery`	`resourceQuery`	the resource query
Return	`osid.resource.ResourceList`		the returned `ResourceList`
Errors	NULL_ARGUMENT		`resourceQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`resourceQuery` is not of this service
Compliance	`mandatory`		This method must be implemented.