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

Interface	osid.rules.check.CheckQuery
Implements	`osid.OsidRuleQuery`
Description	This is the query for searching checks. Each method match specifies an `AND` term while multiple invocations of the same method produce a nested `OR.`
Method	matchFailCheck
Description	Matches fail checks.
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`resourceId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearFailCheckTerms
Description	Clears the fail check query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchTimeCheckStartDate
Description	Matches time checks with start dates within the given range inclusive.
Parameters	`osid.calendaring.DateTime`	`from`	starting date
	`osid.calendaring.DateTime`	`to`	ending date
	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	INVALID_ARGUMENT		`from` is greater than `to`
Errors	NULL_ARGUMENT		`from` or `to` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	matchAnyTimeCheckStartDate
Description	Matches any time check with a start date.
Parameters	`boolean`	`match`	`true` to match any time checks with a start date, `false` to match checks with no start date
Compliance	`mandatory`		This method must be implemented.
Method	clearTimeCheckStartDateTerms
Description	Clears the time check start date query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchTimeCheckEndDate
Description	Matches time checks with end dates within the given range inclusive.
Parameters	`osid.calendaring.DateTime`	`from`	starting date
	`osid.calendaring.DateTime`	`to`	ending date
	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	INVALID_ARGUMENT		`from` is greater than `to`
Errors	NULL_ARGUMENT		`from` or `to` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	matchAnyTimeCheckEndDate
Description	Matches any time check with an end date.
Parameters	`boolean`	`match`	`true` to match any time checks with an end date, `false` to match checks with no end date
Compliance	`mandatory`		This method must be implemented.
Method	clearTimeCheckEndDateTerms
Description	Clears the time check end date query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchTimeCheckDate
Description	Matches time checks with dates overlapping the given date range.
Parameters	`osid.calendaring.DateTime`	`from`	starting date
	`osid.calendaring.DateTime`	`to`	ending date
	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	INVALID_ARGUMENT		`from` is greater than `to`
Errors	NULL_ARGUMENT		`from` or `to` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearTimeCheckDateTerms
Description	Clears the time check date query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchTimeCheckEventId
Description	Sets the event `Id` for this query.
Parameters	`osid.id.Id`	`eventId`	the event `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`eventId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearTimeCheckEventIdTerms
Description	Clears the event `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsTimeCheckEventQuery
Description	Tests if an `EventQuery` is available.
Return	`boolean`		`true` if an event query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getTimeCheckEventQuery
Description	Gets the query for an event. Multiple retrievals produce a nested `OR` term.
Return	`osid.calendaring.EventQuery`		the event query
Errors	UNIMPLEMENTED		`supportsTimeCheckEventQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsTimeCheckEventQuery()` is `true.`
Method	matchAnyTimeCheckEvent
Description	Matches any time check with an event.
Parameters	`boolean`	`match`	`true` to match any time checks with an event, `false` to match checks with no events
Compliance	`mandatory`		This method must be implemented.
Method	clearTimeCheckEventTerms
Description	Clears the event query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchTimeCheckCyclicEventId
Description	Sets the cyclic event `Id` for this query.
Parameters	`osid.id.Id`	`cyclicEventId`	the cyclic event `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`cyclicEventId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearTimeCheckCyclicEventIdTerms
Description	Clears the cyclic event `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsTimeCheckCyclicEventQuery
Description	Tests if a `CyclicEventQuery` is available.
Return	`boolean`		`true` if a cyclic event query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getTimeCheckCyclicEventQuery
Description	Gets the query for a cyclic event. Multiple retrievals produce a nested `OR` term.
Return	`osid.calendaring.cycle.CyclicEventQuery`		the cyclic event query
Errors	UNIMPLEMENTED		`supportsTimeCheckCyclicEventQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsTimeCheckCyclicEventQuery()` is `true.`
Method	matchAnyTimeCheckCyclicEvent
Description	Matches any time check with a cyclic event.
Parameters	`boolean`	`match`	`true` to match any time checks with a cyclic event, `false` to match checks with no cyclic events
Compliance	`mandatory`		This method must be implemented.
Method	clearTimeCheckCyclicEventTerms
Description	Clears the cyclic event query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchHoldCheckBlockId
Description	Sets the block `Id` for this query.
Parameters	`osid.id.Id`	`blockId`	the block `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`blockId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearHoldCheckBlockIdTerms
Description	Clears the block `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsHoldCheckBlockQuery
Description	Tests if a `BlockQuery` is available.
Return	`boolean`		`true` if a block query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getHoldCheckBlockQuery
Description	Gets the query for a block. Multiple retrievals produce a nested `OR` term.
Return	`osid.hold.BlockQuery`		the block query
Errors	UNIMPLEMENTED		`supportsHoldCheckBlockQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsHoldCheckBlockQuery()` is `true.`
Method	matchAnyHoldCheckBlock
Description	Matches any hold check with a block.
Parameters	`boolean`	`match`	`true` to match any hold checks with a block, `false` to match checks with no blocks
Compliance	`mandatory`		This method must be implemented.
Method	clearHoldCheckBlockTerms
Description	Clears the block query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchInquiryCheckAuditId
Description	Sets the audit `Id` for this query.
Parameters	`osid.id.Id`	`auditId`	the audit `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`audirId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearInquiryCheckAuditIdTerms
Description	Clears the audit `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsInquiryCheckAuditQuery
Description	Tests if an `AuditQuery` is available.
Return	`boolean`		`true` if an audit query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getInquiryCheckAuditQuery
Description	Gets the query for an audit. Multiple retrievals produce a nested `OR` term.
Return	`osid.inquiry.AuditQuery`		the audit query
Errors	UNIMPLEMENTED		`supportsInquiryCheckAuditQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsInquiryCheckAuditQuery()` is `true.`
Method	matchAnyInquiryCheckAudit
Description	Matches any inquiry check with an audit.
Parameters	`boolean`	`match`	`true` to match any inqiiry checks with an audit, `false` to match checks with no audits
Compliance	`mandatory`		This method must be implemented.
Method	clearInquiryCheckAuditTerms
Description	Clears the audit query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchProcessCheckAgendaId
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	clearProcessCheckAgendaIdTerms
Description	Clears the agenda `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsProcessCheckAgendaQuery
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	getProcessCheckAgendaQuery
Description	Gets the query for an agenda. Multiple retrievals produce a nested `OR` term.
Return	`osid.rules.check.AgendaQuery`		the agenda query
Errors	UNIMPLEMENTED		`supportsProcessCheckAgendaQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsProcessCheckAgendaQuery()` is `true.`
Method	matchAnyProcessCheckAgenda
Description	Matches any process check with an agenda.
Parameters	`boolean`	`match`	`true` to match any process checks with an agenda, `false` to match checks with no agendas
Compliance	`mandatory`		This method must be implemented.
Method	clearProcessCheckAgendaTerms
Description	Clears the agenda query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchEngineId
Description	Sets the engine `Id` for this query to match checks 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	getCheckQueryRecord
Description	Gets the check query record corresponding to the given `Check` record `Type.` Multiple record retrievals produce a nested `OR` term.
Parameters	`osid.type.Type`	`checkRecordType`	a check record type
Return	`osid.rules.check.records.CheckQueryRecord`		the check query record
Errors	NULL_ARGUMENT		`checkRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`hasRecordType(checkRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.