OSID - osid.control.SettingQuery Service Interface Definition

Interface	osid.control.SettingQuery
Implements	`osid.OsidObjectQuery`
Implements	`osid.OsidSubjugateableQuery`
Description	This is the query for searching settings. Each method match specifies an `AND` term while multiple invocations of the same method produce a nested `OR.`
Method	matchControllerId
Description	Sets the controller `Id` for this query.
Parameters	`osid.id.Id`	`controllerId`	the controller `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`controllerId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearControllerIdTerms
Description	Clears the controller `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsControllerQuery
Description	Tests if a `ControllerQuery` is available.
Return	`boolean`		`true` if a controller query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getControllerQuery
Description	Gets the query for a `InputQntry.` Multiple retrievals produce a nested `OR` term.
Return	`osid.control.ControllerQuery`		the controller query
Errors	UNIMPLEMENTED		`supportsControllerQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsControllerQuery()` is `true.`
Method	clearControllerTerms
Description	Clears the controller query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchOn
Description	Matches on settings.
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Compliance	`mandatory`		This method must be implemented.
Method	clearOnTerms
Description	Clears the on query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchOff
Description	Matches off settings.
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Compliance	`mandatory`		This method must be implemented.
Method	clearOffTerms
Description	Clears the off query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchVariablePercentage
Description	Matches variable percentages between the given range inclusive.
Parameters	`decimal`	`start`	start of range
	`decimal`	`end`	end of range
	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	INVALID_ARGUMENT		`start` is greater than `end`
Errors	NULL_ARGUMENT		`start or end` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	matchAnyVariablePercentage
Description	Matches any variable percentages.
Parameters	`boolean`	`match`	`true` to match settings with variable percentages, `false` to match settings with no variable percentages
Compliance	`mandatory`		This method must be implemented.
Method	clearVariablePercentageTerms
Description	Clears the variable percentages query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchVariableAmount
Description	Matches variable amount between the given range inclusive.
Parameters	`decimal`	`start`	start of range
	`decimal`	`end`	end of range
	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	INVALID_ARGUMENT		`start` is greater than `end`
Errors	NULL_ARGUMENT		`start or end` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	matchAnyVariableAmount
Description	Matches any variable amount.
Parameters	`boolean`	`match`	`true` to match settings with variable amounts, `false` to match settings with no variable amounts
Compliance	`mandatory`		This method must be implemented.
Method	clearVariableAmountTerms
Description	Clears the variable amount query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchDiscreetStateId
Description	Sets the state `Id` for this query.
Parameters	`osid.id.Id`	`stateId`	the state `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`stateId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearDiscreetStateIdTerms
Description	Clears the state `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsDiscreetStateQuery
Description	Tests if a `StateQuery` is available.
Return	`boolean`		`true` if a state query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getDiscreetStateQuery
Description	Gets the query for a `State.` Multiple retrievals produce a nested `OR` term.
Return	`osid.process.StateQuery`		the state query
Errors	UNIMPLEMENTED		`supportsDiscreetStateQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsDiscreetStateQuery()` is `true.`
Method	matchAnyDiscreetState
Description	Matches any discreet states.
Parameters	`boolean`	`match`	`true` to match settings with discreet states, `false` to match settings with no discreet states
Compliance	`mandatory`		This method must be implemented.
Method	clearDiscreetStateTerms
Description	Clears the state query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchRampRate
Description	Matches ramp rates between the given range inclusive.
Parameters	`osid.calendaring.Duration`	`start`	start of range
	`osid.calendaring.Duration`	`end`	end of range
	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	INVALID_ARGUMENT		`start` is greater than `end`
Errors	NULL_ARGUMENT		`start or end` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	matchAnyRampRate
Description	Matches any ramp rate.
Parameters	`boolean`	`match`	`true` to match settings with ramp rates, `false` to match settings with no ramp rates
Compliance	`mandatory`		This method must be implemented.
Method	clearRampRateTerms
Description	Clears the ramp rate query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchSystemId
Description	Sets the system `Id` for this query to match controllers assigned to systems.
Parameters	`osid.id.Id`	`systemId`	the system `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`systemId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearSystemIdTerms
Description	Clears the system `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsSystemQuery
Description	Tests if a `SystemQuery` is available.
Return	`boolean`		`true` if a system query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getSystemQuery
Description	Gets the query for a system. Multiple retrievals produce a nested `OR` term.
Return	`osid.control.SystemQuery`		the system query
Errors	UNIMPLEMENTED		`supportsSystemQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsSystemQuery()` is `true.`
Method	clearSystemTerms
Description	Clears the system query terms.
Compliance	`mandatory`		This method must be implemented.
Method	getSettingQueryRecord
Description	Gets the query record corresponding to the given `Setting` record `Type.` Multiple record retrievals produce a nested `OR` term.
Parameters	`osid.type.Type`	`settingRecordType`	a setting record type
Return	`osid.control.records.SettingQueryRecord`		the setting query record
Errors	NULL_ARGUMENT		`settingRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(settingRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.