OSID - osid.configuration.ParameterSmartConfigurationSession Service Interface Definition

Interface	osid.configuration.ParameterSmartConfigurationSession
Implements	`osid.OsidSession`
Description	This session manages queries and sequencing to create "smart" dynamic catalogs. A `ParameterQuery` can be retrieved from this session and mapped to this `Configuration` to create a virtual collection of `Parameters.` The parameters may be sequenced using the `ParameterSearchOrder` from this session. This `Configuration` has a default query that matches any parameter and a default search order that specifies no sequencing. The queries may be examined using a `ParameterQueryInspector.` The query may be modified by converting the inspector back to a `ParameterQuery.`
Method	getConfigurationId
Description	Gets the `Configuration` `Id` associated with this session.
Return	`osid.id.Id`		the `Configuration Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getConfiguration
Description	Gets the `Configuration` associated with this session.
Return	`osid.configuration.Configuration`		the `Configuration` associated with this session
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageSmartConfigurations
Description	Tests if this user can manage smart configurations. A return of true does not guarantee successful authorization. A return of false indicates that it is known 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 operations to unauthorized users.
Return	`boolean`		`false` if smart cobfiguration management is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getParameterQuery
Description	Gets a parameter query.
Return	`osid.configuration.ParameterQuery`		the parameter query
Compliance	`mandatory`		This method must be implemented.
Method	getParameterSearchOrder
Description	Gets a parameter search order.
Return	`osid.configuration.ParameterSearchOrder`		the parameter search order
Compliance	`mandatory`		This method must be implemented.
Method	applyParameterQuery
Description	Applies a parameter query to this configuration.
Parameters	`osid.configuration.ParameterQuery`	`parameterQuery`	the parameter query
Errors	NULL_ARGUMENT		`parameterQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`parameterQuery` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	inspecParameterQuery
Description	Gets a parameter query inspector for this configuration.
Return	`osid.configuration.ParameterQueryInspector`		the parameter query inspector
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	applyParameterSequencing
Description	Applies a parameter search order to this configuration.
Parameters	`osid.configuration.ParameterSearchOrder`	`parameterSearchOrder`	the parameter search order
Errors	NULL_ARGUMENT		`parameterSearchOrder` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`parameterSearchOrder` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getParameterQueryFromInspector
Description	Gets a parameter query from an inspector.
Parameters	`osid.configuration.ParameterQueryInspector`	`parameterQueryInspector`	a parameter query inspector
Return	`osid.configuration.ParameterQuery`		the parameter query
Errors	NULL_ARGUMENT		`parameterQueryInspector` is `null`
Errors	UNSUPPORTED		`parameterQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.