OSID - osid.control.rules.TriggerEnablerQuery Service Interface Definition

Interface	osid.control.rules.TriggerEnablerQuery
Implements	`osid.OsidEnablerQuery`
Used By	`osid.control.rules.TriggerEnablerQuerySession`
	`osid.control.rules.TriggerEnablerSearchSession`
	`osid.control.rules.TriggerEnablerSmartSystemSession`
Description	This is the query for searching trigger enablers. Each method match specifies an `AND` term while multiple invocations of the same method produce a nested `OR`.
Method	matchRuledTriggerId
Description	Matches enablers mapped to the trigger.
Parameters	`osid.id.Id`	`triggerId`	the trigger `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`triggerId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearRuledTriggerIdTerms
Description	Clears the trigger `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsRuledTriggerQuery
Description	Tests if a `TriggerQuery` is available.
Return	`boolean`		`true` if a trigger query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getRuledTriggerQuery
Description	Gets the query for a trigger. Multiple retrievals produce a nested `OR` term.
Return	`osid.control.TriggerQuery`		the trigger query
Errors	UNIMPLEMENTED		`supportsRuledTriggerQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsRuledTriggerQuery()` is `true`.
Method	matchAnyRuledTrigger
Description	Matches enablers mapped to any trigger.
Parameters	`boolean`	`match`	`true` for enablers mapped to any trigger, `false` to match enablers mapped to no triggers
Compliance	`mandatory`		This method must be implemented.
Method	clearRuledTriggerTerms
Description	Clears the trigger query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchSystemId
Description	Matches enablers mapped to the system.
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	getTriggerEnablerQueryRecord
Description	Gets the trigger enabler query record corresponding to the given `TriggerEnabler` record `Type`. Multiple record retrievals produce a nested `OR` term.
Parameters	`osid.type.Type`	`triggerEnablerRecordType`	a trigger enabler record type
Return	`osid.control.rules.records.TriggerEnablerQueryRecord`		the trigger enabler query record
Errors	NULL_ARGUMENT		`triggerEnablerRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(triggerEnablerRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.