Interface CheckQuery

All Superinterfaces:
Extensible, OsidBrowsableQuery, OsidExtensibleQuery, OsidIdentifiableQuery, OsidObjectQuery, OsidOperableQuery, OsidQuery, OsidRuleQuery, Suppliable
public interface CheckQuery extends OsidRuleQuery

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 Details

    • matchFailCheck

      void matchFailCheck(boolean match)
      Matches fail checks.
      Parameters:
      match - true for a positive match, false for a negative match
      Throws:
      NullArgumentException - resourceId is null
      Compliance:
      mandatory - This method must be implemented.

    • clearFailCheckTerms

      void clearFailCheckTerms()
      Clears the fail check query terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchTimeCheckStartDate

      void matchTimeCheckStartDate(DateTime from, DateTime to, boolean match)
      Matches time checks with start dates within the given range inclusive.
      Parameters:
      from - starting date
      to - ending date
      match - true for a positive match, false for a negative match
      Throws:
      InvalidArgumentException - from is greater than to
      NullArgumentException - from or to is null
      Compliance:
      mandatory - This method must be implemented.

    • matchAnyTimeCheckStartDate

      void matchAnyTimeCheckStartDate(boolean match)
      Matches any time check with a start date.
      Parameters:
      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.

    • clearTimeCheckStartDateTerms

      void clearTimeCheckStartDateTerms()
      Clears the time check start date query terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchTimeCheckEndDate

      void matchTimeCheckEndDate(DateTime from, DateTime to, boolean match)
      Matches time checks with end dates within the given range inclusive.
      Parameters:
      from - starting date
      to - ending date
      match - true for a positive match, false for a negative match
      Throws:
      InvalidArgumentException - from is greater than to
      NullArgumentException - from or to is null
      Compliance:
      mandatory - This method must be implemented.

    • matchAnyTimeCheckEndDate

      void matchAnyTimeCheckEndDate(boolean match)
      Matches any time check with an end date.
      Parameters:
      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.

    • clearTimeCheckEndDateTerms

      void clearTimeCheckEndDateTerms()
      Clears the time check end date query terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchTimeCheckDate

      void matchTimeCheckDate(DateTime from, DateTime to, boolean match)
      Matches time checks with dates overlapping the given date range.
      Parameters:
      from - starting date
      to - ending date
      match - true for a positive match, false for a negative match
      Throws:
      InvalidArgumentException - from is greater than to
      NullArgumentException - from or to is null
      Compliance:
      mandatory - This method must be implemented.

    • clearTimeCheckDateTerms

      void clearTimeCheckDateTerms()
      Clears the time check date query terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchTimeCheckEventId

      void matchTimeCheckEventId(Id eventId, boolean match)
      Sets the event Id for this query.
      Parameters:
      eventId - the event Id
      match - true for a positive match, false for a negative match
      Throws:
      NullArgumentException - eventId is null
      Compliance:
      mandatory - This method must be implemented.

    • clearTimeCheckEventIdTerms

      void clearTimeCheckEventIdTerms()
      Clears the event Id query terms.
      Compliance:
      mandatory - This method must be implemented.

    • supportsTimeCheckEventQuery

      boolean supportsTimeCheckEventQuery()
      Tests if an EventQuery is available.
      Returns:
      true if an event query is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getTimeCheckEventQuery

      EventQuery getTimeCheckEventQuery()
      Gets the query for an event. Multiple retrievals produce a nested OR term.
      Returns:
      the event query
      Throws:
      UnimplementedException - supportsTimeCheckEventQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsTimeCheckEventQuery()} is {@code true} .

    • matchAnyTimeCheckEvent

      void matchAnyTimeCheckEvent(boolean match)
      Matches any time check with an event.
      Parameters:
      match - true to match any time checks with an event, false to match checks with no events
      Compliance:
      mandatory - This method must be implemented.

    • clearTimeCheckEventTerms

      void clearTimeCheckEventTerms()
      Clears the event query terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchTimeCheckCyclicEventId

      void matchTimeCheckCyclicEventId(Id cyclicEventId, boolean match)
      Sets the cyclic event Id for this query.
      Parameters:
      cyclicEventId - the cyclic event Id
      match - true for a positive match, false for a negative match
      Throws:
      NullArgumentException - cyclicEventId is null
      Compliance:
      mandatory - This method must be implemented.

    • clearTimeCheckCyclicEventIdTerms

      void clearTimeCheckCyclicEventIdTerms()
      Clears the cyclic event Id query terms.
      Compliance:
      mandatory - This method must be implemented.

    • supportsTimeCheckCyclicEventQuery

      boolean supportsTimeCheckCyclicEventQuery()
      Tests if a CyclicEventQuery is available.
      Returns:
      true if a cyclic event query is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getTimeCheckCyclicEventQuery

      CyclicEventQuery getTimeCheckCyclicEventQuery()
      Gets the query for a cyclic event. Multiple retrievals produce a nested OR term.
      Returns:
      the cyclic event query
      Throws:
      UnimplementedException - supportsTimeCheckCyclicEventQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsTimeCheckCyclicEventQuery()} is {@code true} .

    • matchAnyTimeCheckCyclicEvent

      void matchAnyTimeCheckCyclicEvent(boolean match)
      Matches any time check with a cyclic event.
      Parameters:
      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.

    • clearTimeCheckCyclicEventTerms

      void clearTimeCheckCyclicEventTerms()
      Clears the cyclic event query terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchHoldCheckBlockId

      void matchHoldCheckBlockId(Id blockId, boolean match)
      Sets the block Id for this query.
      Parameters:
      blockId - the block Id
      match - true for a positive match, false for a negative match
      Throws:
      NullArgumentException - blockId is null
      Compliance:
      mandatory - This method must be implemented.

    • clearHoldCheckBlockIdTerms

      void clearHoldCheckBlockIdTerms()
      Clears the block Id query terms.
      Compliance:
      mandatory - This method must be implemented.

    • supportsHoldCheckBlockQuery

      boolean supportsHoldCheckBlockQuery()
      Tests if a BlockQuery is available.
      Returns:
      true if a block query is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getHoldCheckBlockQuery

      BlockQuery getHoldCheckBlockQuery()
      Gets the query for a block. Multiple retrievals produce a nested OR term.
      Returns:
      the block query
      Throws:
      UnimplementedException - supportsHoldCheckBlockQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsHoldCheckBlockQuery()} is {@code true} .

    • matchAnyHoldCheckBlock

      void matchAnyHoldCheckBlock(boolean match)
      Matches any hold check with a block.
      Parameters:
      match - true to match any hold checks with a block, false to match checks with no blocks
      Compliance:
      mandatory - This method must be implemented.

    • clearHoldCheckBlockTerms

      void clearHoldCheckBlockTerms()
      Clears the block query terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchAuthorizationCheckFunctionId

      void matchAuthorizationCheckFunctionId(Id functionId, boolean match)
      Sets the function Id for this query.
      Parameters:
      functionId - the function Id
      match - true for a positive match, false for a negative match
      Throws:
      NullArgumentException - functionId is null
      Compliance:
      mandatory - This method must be implemented.

    • clearAuthorizationCheckFunctionIdTerms

      void clearAuthorizationCheckFunctionIdTerms()
      Clears the function Id query terms.
      Compliance:
      mandatory - This method must be implemented.

    • supportsAuthorizationCheckFunctionQuery

      boolean supportsAuthorizationCheckFunctionQuery()
      Tests if a FunctionQuery is available.
      Returns:
      true if a function query is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getAuthorizationCheckFunctionQuery

      FunctionQuery getAuthorizationCheckFunctionQuery()
      Gets the query for a function. Multiple retrievals produce a nested OR term.
      Returns:
      the function query
      Throws:
      UnimplementedException - supportsAuthorizationCheckFunctionQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsAuthorizationCheckFunctionQuery()} is {@code true} .

    • matchAnyAuthorizationCheckFunction

      void matchAnyAuthorizationCheckFunction(boolean match)
      Matches any authorization check with a function.
      Parameters:
      match - true to match any authorization checks with a function, false to match checks with no functions
      Compliance:
      mandatory - This method must be implemented.

    • clearAuthorizationCheckFunctionTerms

      void clearAuthorizationCheckFunctionTerms()
      Clears the function query terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchInquiryCheckAuditId

      void matchInquiryCheckAuditId(Id auditId, boolean match)
      Sets the audit Id for this query.
      Parameters:
      auditId - the audit Id
      match - true for a positive match, false for a negative match
      Throws:
      NullArgumentException - audirId is null
      Compliance:
      mandatory - This method must be implemented.

    • clearInquiryCheckAuditIdTerms

      void clearInquiryCheckAuditIdTerms()
      Clears the audit Id query terms.
      Compliance:
      mandatory - This method must be implemented.

    • supportsInquiryCheckAuditQuery

      boolean supportsInquiryCheckAuditQuery()
      Tests if an AuditQuery is available.
      Returns:
      true if an audit query is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getInquiryCheckAuditQuery

      AuditQuery getInquiryCheckAuditQuery()
      Gets the query for an audit. Multiple retrievals produce a nested OR term.
      Returns:
      the audit query
      Throws:
      UnimplementedException - supportsInquiryCheckAuditQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsInquiryCheckAuditQuery()} is {@code true} .

    • matchAnyInquiryCheckAudit

      void matchAnyInquiryCheckAudit(boolean match)
      Matches any inquiry check with an audit.
      Parameters:
      match - true to match any inqiiry checks with an audit, false to match checks with no audits
      Compliance:
      mandatory - This method must be implemented.

    • clearInquiryCheckAuditTerms

      void clearInquiryCheckAuditTerms()
      Clears the audit query terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchProcessCheckAgendaId

      void matchProcessCheckAgendaId(Id agendaId, boolean match)
      Sets the agenda Id for this query.
      Parameters:
      agendaId - the agenda Id
      match - true for a positive match, false for a negative match
      Throws:
      NullArgumentException - agendaId is null
      Compliance:
      mandatory - This method must be implemented.

    • clearProcessCheckAgendaIdTerms

      void clearProcessCheckAgendaIdTerms()
      Clears the agenda Id query terms.
      Compliance:
      mandatory - This method must be implemented.

    • supportsProcessCheckAgendaQuery

      boolean supportsProcessCheckAgendaQuery()
      Tests if an AgendaQuery is available.
      Returns:
      true if an agenda query is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getProcessCheckAgendaQuery

      AgendaQuery getProcessCheckAgendaQuery()
      Gets the query for an agenda. Multiple retrievals produce a nested OR term.
      Returns:
      the agenda query
      Throws:
      UnimplementedException - supportsProcessCheckAgendaQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsProcessCheckAgendaQuery()} is {@code true} .

    • matchAnyProcessCheckAgenda

      void matchAnyProcessCheckAgenda(boolean match)
      Matches any process check with an agenda.
      Parameters:
      match - true to match any process checks with an agenda, false to match checks with no agendas
      Compliance:
      mandatory - This method must be implemented.

    • clearProcessCheckAgendaTerms

      void clearProcessCheckAgendaTerms()
      Clears the agenda query terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchLoggingCheckTextId

      void matchLoggingCheckTextId(Id textId, boolean match)
      Sets the text Id for this query.
      Parameters:
      textId - the text Id
      match - true for a positive match, false for a negative match
      Throws:
      NullArgumentException - textId is null
      Compliance:
      mandatory - This method must be implemented.

    • clearLoggingCheckTextIdTerms

      void clearLoggingCheckTextIdTerms()
      Clears the text Id query terms.
      Compliance:
      mandatory - This method must be implemented.

    • supportsLoggingCheckTextQuery

      boolean supportsLoggingCheckTextQuery()
      Tests if a TextQuery is available.
      Returns:
      true if a text query is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getLoggingCheckTextQuery

      TextQuery getLoggingCheckTextQuery()
      Gets the query for a text. Multiple retrievals produce a nested OR term.
      Returns:
      the text query
      Throws:
      UnimplementedException - supportsLoggingCheckTextQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsLoggingCheckTextQuery()} is {@code true} .

    • matchAnyLoggingCheckText

      void matchAnyLoggingCheckText(boolean match)
      Matches any logging check with a text.
      Parameters:
      match - true to match any logging checks with a text, false to match checks with no texts
      Compliance:
      mandatory - This method must be implemented.

    • clearLoggingCheckTextTerms

      void clearLoggingCheckTextTerms()
      Clears the text query terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchEngineId

      void matchEngineId(Id engineId, boolean match)
      Sets the engine Id for this query to match checks assigned to engines.
      Parameters:
      engineId - the engine Id
      match - true for a positive match, false for a negative match
      Throws:
      NullArgumentException - engineId is null
      Compliance:
      mandatory - This method must be implemented.

    • clearEngineIdTerms

      void clearEngineIdTerms()
      Clears the engine Id query terms.
      Compliance:
      mandatory - This method must be implemented.

    • supportsEngineQuery

      boolean supportsEngineQuery()
      Tests if a EngineQuery is available.
      Returns:
      true if an engine query is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getEngineQuery

      EngineQuery getEngineQuery()
      Gets the query for an engine. Multiple retrievals produce a nested OR term.
      Returns:
      the engine query
      Throws:
      UnimplementedException - supportsEngineQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsEngineQuery()} is {@code true} .

    • clearEngineTerms

      void clearEngineTerms()
      Clears the engine query terms.
      Compliance:
      mandatory - This method must be implemented.

    • getCheckQueryRecord

      CheckQueryRecord getCheckQueryRecord(Type checkRecordType) throws OperationFailedException, PermissionDeniedException
      Gets the check query record corresponding to the given Check record Type .Multiple record retrievals produce a nested OR term.
      Parameters:
      checkRecordType - a check record type
      Returns:
      the check query record
      Throws:
      NullArgumentException - checkRecordType is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure occurred
      UnsupportedException - hasRecordType(checkRecordType) is false
      Compliance:
      mandatory - This method must be implemented.