OSID - osid.lexicon.ParameterQuerySession Service Interface Definition

Interface	osid.lexicon.ParameterQuerySession
Implements	`osid.OsidSession`
Implemented By	`osid.lexicon.ParameterSearchSession`
Used By	`osid.lexicon.LexiconManager`
Used By	`osid.lexicon.LexiconProxyManager`
Description	This session provides methods for searching among `Parameters` . The search query is constructed using the `ParameterQuery` . This session defines views that offer differing behaviors for searching. federated press view: searches include parameters in presses of which this press is an ancestor in the press hierarchy isolated press view: searches are restricted to parameters in this press Parameters may have a query record indicated by their respective record types. The query record is accessed via the `ParameterQuery` .
Method	getPressId
Description	Gets the `Press` `Id` associated with this session.
Return	`osid.id.Id`		the `Press Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getPress
Description	Gets the `Press` associated with this session.
Return	`osid.lexicon.Press`		the press
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canSearchParameters
Description	Tests if this user can perform `Parameter` 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 press that may not offer lookup operations to unauthorized users.
Return	`boolean`		`false` if search methods are not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	useFederatedPressView
Description	Federates the view for methods in this session. A federated view will include parameters in presses which are children of this press in the press hierarchy.
Compliance	`mandatory`		This method is must be implemented.
Method	useIsolatedPressView
Description	Isolates the view for methods in this session. An isolated view restricts lookups to this press only.
Compliance	`mandatory`		This method is must be implemented.
Method	getParameterQuery
Description	Gets a parameter query.
Return	`osid.lexicon.ParameterQuery`		the parameter query
Compliance	`mandatory`		This method must be implemented.
Method	getParametersByQuery
Description	Gets a list of `Parameters` matching the given parameter query.
Parameters	`osid.lexicon.ParameterQuery`	`parameterQuery`	the parameter query
Return	`osid.lexicon.ParameterList`		the returned `ParameterList`
Errors	NULL_ARGUMENT		`parameterQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`parameterQuery` is not of this service
Compliance	`mandatory`		This method must be implemented.