OSID - osid.configuration.rules.ParameterProcessorEnablerQuery Service Interface Definition

Interface	osid.configuration.rules.ParameterProcessorEnablerQuery
Implements	`osid.OsidEnablerQuery`
Used By	`osid.configuration.rules.ParameterProcessorEnablerQuerySession`
	`osid.configuration.rules.ParameterProcessorEnablerSearchSession`
	`osid.configuration.rules.ParameterProcessorEnablerSmartConfigurationSession`
Description	This is the query for searching parameter processor enablers. Each method match specifies an `AND` term while multiple invocations of the same method produce a nested `OR`.
Method	matchRuledParameterProcessorId
Description	Matches enablers mapped to the parameter processor.
Parameters	`osid.id.Id`	`parameterProcessorId`	the parameter processor `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`parameterProcessorId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearRuledParameterProcessorIdTerms
Description	Clears the parameter processor `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsRuledParameterProcessorQuery
Description	Tests if a `ParameterProcessorQuery` is available.
Return	`boolean`		`true` if a parameter processor query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getRuledParameterProcessorQuery
Description	Gets the query for a parameter processor. Multiple retrievals produce a nested `OR` term.
Return	`osid.configuration.rules.ParameterProcessorQuery`		the parameter processor query
Errors	UNIMPLEMENTED		`supportsRuledParameterProcessorQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsRuledParameterProcessorQuery()` is `true`.
Method	matchAnyRuledParameterProcessor
Description	Matches enablers mapped to any parameter processor.
Parameters	`boolean`	`match`	`true` for enablers mapped to any parameter processor, `false` to match enablers mapped to no parameter processors
Compliance	`mandatory`		This method must be implemented.
Method	clearRuledParameterProcessorTerms
Description	Clears the parameter processor query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchConfigurationId
Description	Matches enablers mapped to the configuration.
Parameters	`osid.id.Id`	`configurationId`	the configuration `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`configurationId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearConfigurationIdTerms
Description	Clears the configuration `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsConfigurationQuery
Description	Tests if a `ConfigurationQuery` is available.
Return	`boolean`		`true` if a configuration query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getConfigurationQuery
Description	Gets the query for a configuration. Multiple retrievals produce a nested `OR` term.
Return	`osid.configuration.ConfigurationQuery`		the configuration query
Errors	UNIMPLEMENTED		`supportsConfigurationQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsConfigurationQuery()` is `true`.
Method	clearConfigurationTerms
Description	Clears the configuration query terms.
Compliance	`mandatory`		This method must be implemented.
Method	getParameterProcessorEnablerQueryRecord
Description	Gets the parameter processor enabler query record corresponding to the given `ParameterProcessorEnabler` record `Type`. Multiple record retrievals produce a nested `OR` term.
Parameters	`osid.type.Type`	`parameterProcessorEnablerRecordType`	a parameter processor enabler record type
Return	`osid.configuration.rules.records.ParameterProcessorEnablerQueryRecord`		the parameter processor enabler query record
Errors	NULL_ARGUMENT		`parameterProcessorEnablerRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(parameterProcessorEnablerRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.