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

Interface	osid.rules.check.AgendaQuery
Implements	`osid.OsidObjectQuery`
Description	This is the query for searching agendas. Each method match specifies an `AND` term while multiple invocations of the same method produce a nested `OR.`
Method	matchInstructionId
Description	Sets the instruction `Id` for this query.
Parameters	`osid.id.Id`	`qualifierId`	the instruction `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`instructionId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearInstructionIdTerms
Description	Clears the instruction `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsInstructionQuery
Description	Tests if an `InstructionQuery` is available.
Return	`boolean`		`true` if an instruction query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getInstructionQuery
Description	Gets the query for an instruction. Multiple retrievals produce a nested `OR` term.
Return	`osid.rules.check.InstructionQuery`		the instruction query
Errors	UNIMPLEMENTED		`supportsInstructionQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsInstructionQuery()` is `true.`
Method	matchAnyInstruction
Description	Matches agendas that have any instruction.
Parameters	`boolean`	`match`	`true` to match agendas with any instruction, `false` to match agendas with no instruction
Compliance	`mandatory`		This method must be implemented.
Method	clearInstructionTerms
Description	Clears the instruction query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchEngineId
Description	Sets the engine `Id` for this query to match agendas 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	getAgendaQueryRecord
Description	Gets the agenda query record corresponding to the given `Agenda` record `Type.` Multiple record retrievals produce a nested `OR` term.
Parameters	`osid.type.Type`	`agendaRecordType`	an agenda record type
Return	`osid.rules.check.records.AgendaQueryRecord`		the agenda query record
Errors	NULL_ARGUMENT		`agendaRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`hasRecordType(agendaRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.