OSID - osid.rules.check.InstructionQuery Service Interface Definition

Interface	osid.rules.check.InstructionQuery
Implements	`osid.OsidRelationshipQuery`
Implements	`osid.OsidRuleApplicatorQuery`
Used By	`osid.rules.check.InstructionQuerySession`
	`osid.rules.check.InstructionSearchSession`
	`osid.rules.check.InstructionSmartEngineSession`
Description	This is the query for searching instructions. Each method match specifies an `AND` term while multiple invocations of the same method produce a nested `OR`.
Method	matchAgendaId
Description	Sets the agenda `Id` for this query.
Parameters	`osid.id.Id`	`agendaId`	the agenda `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`agendaId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearAgendaIdTerms
Description	Clears the agenda `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsAgendaQuery
Description	Tests if an `AgendaQuery` is available.
Return	`boolean`		`true` if an agenda query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getAgendaQuery
Description	Gets the query for an agenda. Multiple retrievals produce a nested `OR` term.
Return	`osid.rules.check.AgendaQuery`		the agenda query
Errors	UNIMPLEMENTED		`supportsAgendaQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsAgendaQuery()` is `true`.
Method	clearAgendaTerms
Description	Clears the agenda query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchCheckId
Description	Sets the check `Id` for this query.
Parameters	`osid.id.Id`	`checkId`	the check `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`checkId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearCheckIdTerms
Description	Clears the check `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsCheckQuery
Description	Tests if a `CheckQuery` is available.
Return	`boolean`		`true` if a check query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getCheckQuery
Description	Gets the query for a check. Multiple retrievals produce a nested `OR` term.
Return	`osid.rules.check.CheckQuery`		the check query
Errors	UNIMPLEMENTED		`supportsCheckQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsCheckQuery()` is `true`.
Method	clearCheckTerms
Description	Clears the check query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchMessage
Description	Adds a message for this query.
Parameters	`string`	`message`	message string to match
	`osid.type.Type`	`stringMatchType`	the string match type
	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	INVALID_ARGUMENT		`message` not of `stringMatchType`
	NULL_ARGUMENT		`message` or `stringMatchType` is `null`
	UNSUPPORTED		`supportsStringMatchType(stringMatchType)` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	matchAnyMessage
Description	Matches instructions that have any message.
Parameters	`boolean`	`match`	`true` to match instructions with any message, `false` to match instructions with no message
Compliance	`mandatory`		This method must be implemented.
Method	clearMessageTerms
Description	Clears the message query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchWarning
Description	Matches warnings.
Parameters	`boolean`	`match`	`true` to match warnings, `false` to match hard errors
Compliance	`mandatory`		This method must be implemented.
Method	matchAnyWarning
Description	Matches instructions that have any warning status set.
Parameters	`boolean`	`match`	`true` to match instructions with any warning status set, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	clearWarningTerms
Description	Clears the warning query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchContinueOnFail
Description	Matches continue-on-fail instructions.
Parameters	`boolean`	`match`	`true` to match continue-on-fail instructions, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	matchAnyContinueOnFail
Description	Matches instructions that have any continue on fail status set.
Parameters	`boolean`	`match`	`true` to match instructions with any continue on fail status set, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	clearContinueOnFailTerms
Description	Clears the continue-on-fail query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchBreakOnSuccess
Description	Matches break-on-successl instructions.
Parameters	`boolean`	`match`	`true` to match break-on-successl instructions, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	matchAnyBreakOnSuccess
Description	Matches instructions that have any break on success status set.
Parameters	`boolean`	`match`	`true` to match instructions with any break on success status set, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	clearBreakOnSuccessTerms
Description	Clears the break-on-success query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchEngineId
Description	Sets the engine `Id` for this query to match instructions assigned to engines.
Parameters	`osid.id.Id`	`engineId`	the engine `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`engineId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearEngineIdTerms
Description	Clears the engine `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsEngineQuery
Description	Tests if a `EngineQuery` is available.
Return	`boolean`		`true` if an engine query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getEngineQuery
Description	Gets the query for an engine. Multiple retrievals produce a nested `OR` term.
Return	`osid.rules.EngineQuery`		the engine query
Errors	UNIMPLEMENTED		`supportsEngineQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsEngineQuery()` is `true`.
Method	clearEngineTerms
Description	Clears the engine query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchOrder
Description	Matches instructions within the given order range inclusive.
Parameters	`integer`	`from`	start of range
	`integer`	`to`	end of range
	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	INVALID_ARGUMENT		`from` is greater than `to`
Compliance	`mandatory`		This method must be implemented.
Method	clearOrderTerms
Description	Clears the order terms.
Compliance	`mandatory`		This method must be implemented.
Method	getInstructionQueryRecord
Description	Gets the instruction query record corresponding to the given `Instruction` record `Type`. Multiple record retrievals produce a nested `OR` term.
Parameters	`osid.type.Type`	`instructionRecordType`	an instruction record type
Return	`osid.rules.check.records.InstructionQueryRecord`		the instruction query record
Errors	NULL_ARGUMENT		`instructionRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`hasRecordType(instructionRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.