OSID Logo
OSID Specifications
rules check package
Version 3.0.0
Release Candidate Preview
Interfaceosid.rules.check.CheckQuery
Implementsosid.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.

MethodmatchFailCheck
Description

Matches fail checks.

Parametersbooleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT resourceId is null
CompliancemandatoryThis method must be implemented.
MethodclearFailCheckTerms
Description

Clears the fail check query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchTimeCheckStartDate
Description

Matches time checks with start dates within the given range inclusive.

Parametersosid.calendaring.DateTimefromstarting date
osid.calendaring.DateTimetoending date
booleanmatch true for a positive match, false for a negative match
ErrorsINVALID_ARGUMENT from is greater than to
NULL_ARGUMENT from or to is null
CompliancemandatoryThis method must be implemented.
MethodmatchAnyTimeCheckStartDate
Description

Matches any time check with a start date.

Parametersbooleanmatch true to match any time checks with a start date, false to match checks with no start date
CompliancemandatoryThis method must be implemented.
MethodclearTimeCheckStartDateTerms
Description

Clears the time check start date query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchTimeCheckEndDate
Description

Matches time checks with end dates within the given range inclusive.

Parametersosid.calendaring.DateTimefromstarting date
osid.calendaring.DateTimetoending date
booleanmatch true for a positive match, false for a negative match
ErrorsINVALID_ARGUMENT from is greater than to
NULL_ARGUMENT from or to is null
CompliancemandatoryThis method must be implemented.
MethodmatchAnyTimeCheckEndDate
Description

Matches any time check with an end date.

Parametersbooleanmatch true to match any time checks with an end date, false to match checks with no end date
CompliancemandatoryThis method must be implemented.
MethodclearTimeCheckEndDateTerms
Description

Clears the time check end date query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchTimeCheckDate
Description

Matches time checks with dates overlapping the given date range.

Parametersosid.calendaring.DateTimefromstarting date
osid.calendaring.DateTimetoending date
booleanmatch true for a positive match, false for a negative match
ErrorsINVALID_ARGUMENT from is greater than to
NULL_ARGUMENT from or to is null
CompliancemandatoryThis method must be implemented.
MethodclearTimeCheckDateTerms
Description

Clears the time check date query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchTimeCheckEventId
Description

Sets the event Id for this query.

Parametersosid.id.IdeventIdthe event Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT eventId is null
CompliancemandatoryThis method must be implemented.
MethodclearTimeCheckEventIdTerms
Description

Clears the event Id query terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsTimeCheckEventQuery
Description

Tests if an EventQuery is available.

Returnboolean true if an event query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetTimeCheckEventQuery
Description

Gets the query for an event. Multiple retrievals produce a nested OR term.

Returnosid.calendaring.EventQuerythe event query
ErrorsUNIMPLEMENTED supportsTimeCheckEventQuery() is false
ComplianceoptionalThis method must be implemented if supportsTimeCheckEventQuery() is true.
MethodmatchAnyTimeCheckEvent
Description

Matches any time check with an event.

Parametersbooleanmatch true to match any time checks with an event, false to match checks with no events
CompliancemandatoryThis method must be implemented.
MethodclearTimeCheckEventTerms
Description

Clears the event query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchTimeCheckCyclicEventId
Description

Sets the cyclic event Id for this query.

Parametersosid.id.IdcyclicEventIdthe cyclic event Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT cyclicEventId is null
CompliancemandatoryThis method must be implemented.
MethodclearTimeCheckCyclicEventIdTerms
Description

Clears the cyclic event Id query terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsTimeCheckCyclicEventQuery
Description

Tests if a CyclicEventQuery is available.

Returnboolean true if a cyclic event query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetTimeCheckCyclicEventQuery
Description

Gets the query for a cyclic event. Multiple retrievals produce a nested OR term.

Returnosid.calendaring.cycle.CyclicEventQuerythe cyclic event query
ErrorsUNIMPLEMENTED supportsTimeCheckCyclicEventQuery() is false
ComplianceoptionalThis method must be implemented if supportsTimeCheckCyclicEventQuery() is true.
MethodmatchAnyTimeCheckCyclicEvent
Description

Matches any time check with a cyclic event.

Parametersbooleanmatch true to match any time checks with a cyclic event, false to match checks with no cyclic events
CompliancemandatoryThis method must be implemented.
MethodclearTimeCheckCyclicEventTerms
Description

Clears the cyclic event query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchHoldCheckBlockId
Description

Sets the block Id for this query.

Parametersosid.id.IdblockIdthe block Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT blockId is null
CompliancemandatoryThis method must be implemented.
MethodclearHoldCheckBlockIdTerms
Description

Clears the block Id query terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsHoldCheckBlockQuery
Description

Tests if a BlockQuery is available.

Returnboolean true if a block query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetHoldCheckBlockQuery
Description

Gets the query for a block. Multiple retrievals produce a nested OR term.

Returnosid.hold.BlockQuerythe block query
ErrorsUNIMPLEMENTED supportsHoldCheckBlockQuery() is false
ComplianceoptionalThis method must be implemented if supportsHoldCheckBlockQuery() is true.
MethodmatchAnyHoldCheckBlock
Description

Matches any hold check with a block.

Parametersbooleanmatch true to match any hold checks with a block, false to match checks with no blocks
CompliancemandatoryThis method must be implemented.
MethodclearHoldCheckBlockTerms
Description

Clears the block query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchInquiryCheckAuditId
Description

Sets the audit Id for this query.

Parametersosid.id.IdauditIdthe audit Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT audirId is null
CompliancemandatoryThis method must be implemented.
MethodclearInquiryCheckAuditIdTerms
Description

Clears the audit Id query terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsInquiryCheckAuditQuery
Description

Tests if an AuditQuery is available.

Returnboolean true if an audit query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetInquiryCheckAuditQuery
Description

Gets the query for an audit. Multiple retrievals produce a nested OR term.

Returnosid.inquiry.AuditQuerythe audit query
ErrorsUNIMPLEMENTED supportsInquiryCheckAuditQuery() is false
ComplianceoptionalThis method must be implemented if supportsInquiryCheckAuditQuery() is true.
MethodmatchAnyInquiryCheckAudit
Description

Matches any inquiry check with an audit.

Parametersbooleanmatch true to match any inqiiry checks with an audit, false to match checks with no audits
CompliancemandatoryThis method must be implemented.
MethodclearInquiryCheckAuditTerms
Description

Clears the audit query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchProcessCheckAgendaId
Description

Sets the agenda Id for this query.

Parametersosid.id.IdagendaIdthe agenda Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT agendaId is null
CompliancemandatoryThis method must be implemented.
MethodclearProcessCheckAgendaIdTerms
Description

Clears the agenda Id query terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsProcessCheckAgendaQuery
Description

Tests if an AgendaQuery is available.

Returnboolean true if an agenda query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetProcessCheckAgendaQuery
Description

Gets the query for an agenda. Multiple retrievals produce a nested OR term.

Returnosid.rules.check.AgendaQuerythe agenda query
ErrorsUNIMPLEMENTED supportsProcessCheckAgendaQuery() is false
ComplianceoptionalThis method must be implemented if supportsProcessCheckAgendaQuery() is true.
MethodmatchAnyProcessCheckAgenda
Description

Matches any process check with an agenda.

Parametersbooleanmatch true to match any process checks with an agenda, false to match checks with no agendas
CompliancemandatoryThis method must be implemented.
MethodclearProcessCheckAgendaTerms
Description

Clears the agenda query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchEngineId
Description

Sets the engine Id for this query to match checks assigned to engines.

Parametersosid.id.IdengineIdthe engine Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT engineId is null
CompliancemandatoryThis method must be implemented.
MethodclearEngineIdTerms
Description

Clears the engine Id query terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsEngineQuery
Description

Tests if a EngineQuery is available.

Returnboolean true if an engine query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetEngineQuery
Description

Gets the query for an engine. Multiple retrievals produce a nested OR term.

Returnosid.rules.EngineQuerythe engine query
ErrorsUNIMPLEMENTED supportsEngineQuery() is false
ComplianceoptionalThis method must be implemented if supportsEngineQuery() is true.
MethodclearEngineTerms
Description

Clears the engine query terms.

CompliancemandatoryThis method must be implemented.
MethodgetCheckQueryRecord
Description

Gets the check query record corresponding to the given Check record Type. Multiple record retrievals produce a nested OR term.

Parametersosid.type.TypecheckRecordTypea check record type
Returnosid.rules.check.records.CheckQueryRecordthe check query record
ErrorsNULL_ARGUMENT checkRecordType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED hasRecordType(checkRecordType) is false
CompliancemandatoryThis method must be implemented.