OSID - osid.mapping.path.rules.SignalEnablerQuery Service Interface Definition

Interface	osid.mapping.path.rules.SignalEnablerQuery
Implements	`osid.OsidEnablerQuery`
Used By	`osid.mapping.path.rules.SignalEnablerQuerySession`
	`osid.mapping.path.rules.SignalEnablerSearchSession`
	`osid.mapping.path.rules.SignalEnablerSmartMapSession`
Description	This is the query for searching signal enablers. Each method match specifies an `AND` term while multiple invocations of the same method produce a nested `OR`.
Method	matchRuledSignalId
Description	Matches enablers mapped to a signal.
Parameters	`osid.id.Id`	`signalId`	the signal `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`signalId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearRuledSignalIdTerms
Description	Clears the signal `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsRuledSignalQuery
Description	Tests if a `SignalQuery` is available.
Return	`boolean`		`true` if a signal query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getRuledSignalQuery
Description	Gets the query for a signal. Multiple retrievals produce a nested `OR` term.
Return	`osid.mapping.path.SignalQuery`		the signal query
Errors	UNIMPLEMENTED		`supportsRuledSignalQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsRuledSignalQuery()` is `true`.
Method	matchAnyRuledSignal
Description	Matches rules mapped to any signal.
Parameters	`boolean`	`match`	`true` for rules mapped to any signal, `false` to match rules mapped to no signals
Compliance	`mandatory`		This method must be implemented.
Method	clearRuledSignalTerms
Description	Clears the signal query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchMapId
Description	Matches enablers mapped to a map.
Parameters	`osid.id.Id`	`mapId`	the map `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`mapId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearMapIdTerms
Description	Clears the map `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsMapQuery
Description	Tests if a `MapQuery` is available.
Return	`boolean`		`true` if a map query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getMapQuery
Description	Gets the query for a map. Multiple retrievals produce a nested `OR` term.
Return	`osid.mapping.MapQuery`		the map query
Errors	UNIMPLEMENTED		`supportsMapQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsMapQuery()` is `true`.
Method	clearMapTerms
Description	Clears the map query terms.
Compliance	`mandatory`		This method must be implemented.
Method	getSignalEnablerQueryRecord
Description	Gets the signal enabler query record corresponding to the given `SignalEnabler` record `Type`. Multiple record retrievals produce a nested `OR` term.
Parameters	`osid.type.Type`	`signalEnablerRecordType`	a signal enabler record type
Return	`osid.mapping.path.rules.records.SignalEnablerQueryRecord`		the signal enabler query record
Errors	NULL_ARGUMENT		`signalEnablerRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(signalEnablerRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.