OSID - osid.configuration.ConfigurationQuery Service Interface Definition

Interface	osid.configuration.ConfigurationQuery
Implements	`osid.OsidCatalogQuery`
Used By	`osid.configuration.ConfigurationQuery`
	`osid.configuration.ConfigurationQuerySession`
	`osid.configuration.ConfigurationSearchSession`
	`osid.configuration.ParameterQuery`
	`osid.configuration.ValueQuery`
	`osid.configuration.rules.ParameterProcessorEnablerQuery`
	`osid.configuration.rules.ParameterProcessorQuery`
	`osid.configuration.rules.ValueEnablerQuery`
Description	This is the query for searching configurations. Each method match request produces an `AND` term while multiple invocations of a method produces a nested `OR`, except for accessing the `ConfigurationQuery` subinterface.
Method	matchRegistry
Description	Matches configurations which are parameter registries.
Parameters	`boolean`	`match`	`true` for a positive match, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	clearRegistryTerms
Description	Clears the registry terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchParameterId
Description	Adds a parameter `Id` for this query.
Parameters	`osid.id.Id`	`parameterId`	a parameter `Id`
Parameters	`boolean`	`match`	`true` if a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`parameterId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearParameterIdTerms
Description	Clears the parameter `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsParameterQuery
Description	Tests if a `ParameterQuery` is available.
Return	`boolean`		`true` if a parameter query interface is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getParameterQuery
Description	Gets the query interface for a parameter.
Return	`osid.configuration.ParameterQuery`		the parameter query
Errors	UNIMPLEMENTED		`supportsParameterQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsParameterQuery()` is `true`.
Method	matchAnyParameter
Description	Matches configurations that have any parameter.
Parameters	`boolean`	`match`	`true` to match configurations with any parameter, `false` to match configurations with no parameter
Compliance	`mandatory`		This method must be implemented.
Method	clearParameterTerms
Description	Clears the parameter terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchAncestorConfigurationId
Description	Adds a configuration `Id` for this query to match configurations which have as an ancestor the specified configuration.
Parameters	`osid.id.Id`	`configurationId`	a configuration `Id`
Parameters	`boolean`	`match`	`true` if a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`configurationId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearAncestorConfigurationIdTerms
Description	Clears the ancestor configuration `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsAncestorConfigurationQuery
Description	Tests if a `ConfigurationQuery` is available.
Return	`boolean`		`true` if a configuration query interface is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getAncestorConfigurationQuery
Description	Gets the query interface for a configuration.
Return	`osid.configuration.ConfigurationQuery`		the configuration query
Errors	UNIMPLEMENTED		`supportsAncestorConfigurationQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsAncestorConfigurationQuery()` is `true`.
Method	matchAnyAncestorConfiguration
Description	Matches configurations that have any ancestor.
Parameters	`boolean`	`match`	`true` to match configurations with any ancestor, `false` to match root configurations
Compliance	`mandatory`		This method must be implemented.
Method	clearAncestorConfigurationTerms
Description	Clears the ancestor configuration terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchDescendantConfigurationId
Description	Adds a configuration `Id` for this query to match configurations which have as a descendant the specified configuration.
Parameters	`osid.id.Id`	`configurationId`	a configuration `Id`
Parameters	`boolean`	`match`	`true` if a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`configurationId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearDescendantConfigurationIdTerms
Description	Clears the descendant configuration `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsDescendantConfigurationQuery
Description	Tests if a `ConfigurationQuery` is available.
Return	`boolean`		`true` if a configuration query interface is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getDescendantConfigurationQuery
Description	Gets the query interface for a configuration.
Return	`osid.configuration.ConfigurationQuery`		the configuration query
Errors	UNIMPLEMENTED		`supportsDescendantConfigurationQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsDescendantConfigurationQuery()` is `true`.
Method	matchAnyDescendantConfiguration
Description	Matches configurations that have any descendant.
Parameters	`boolean`	`match`	`true` to match configurations with any descendant, `false` to match leaf configurations
Compliance	`mandatory`		This method must be implemented.
Method	clearDescendantConfigurationTerms
Description	Clears the descendant configuration terms.
Compliance	`mandatory`		This method must be implemented.
Method	getConfigurationQueryRecord
Description	Gets the configuration query record corresponding to the given `Configuration` record `Type`. Multiple record retrievals produce a nested `OR` term.
Parameters	`osid.type.Type`	`configurationRecordType`	a configuration record type
Return	`osid.configuration.records.ConfigurationQueryRecord`		the configuration query record
Errors	NULL_ARGUMENT		`configurationRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(configurationRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.