Interface IssueQuery

All Superinterfaces:
Extensible, OsidBrowsableQuery, OsidExtensibleQuery, OsidIdentifiableQuery, OsidObjectQuery, OsidQuery, OsidRelationshipQuery, OsidTemporalQuery, Suppliable
public interface IssueQuery extends OsidRelationshipQuery

This is the query for searching issues. Each method match specifies an AND term while multiple invocations of the same method produce a nested OR .

  • Method Details

    • matchQueueId

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

    • clearQueueIdTerms

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

    • supportsQueueQuery

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

    • getQueueQuery

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

    • clearQueueTerms

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

    • matchCustomerId

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

    • clearCustomerIdTerms

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

    • supportsCustomerQuery

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

    • getCustomerQuery

      ResourceQuery getCustomerQuery()
      Gets the query for a customer. Multiple retrievals produce a nested OR term.
      Returns:
      the resource query
      Throws:
      UnimplementedException - supportsCustomerQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsCustomerQuery()} is {@code true} .

    • clearCustomerTerms

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

    • matchTopicId

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

    • clearTopicIdTerms

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

    • supportsTopicQuery

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

    • getTopicQuery

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

    • matchAnyTopic

      void matchAnyTopic(boolean match)
      Matches issues that have any topic.
      Parameters:
      match - true to match issues with any topic, false to match issues with no topic
      Compliance:
      mandatory - This method must be implemented.

    • clearTopicTerms

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

    • matchSubtaskId

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

    • clearSubtaskIdTerms

      void clearSubtaskIdTerms()
      Clears the subtask issue Id query terms.
      Compliance:
      mandatory - This method must be implemented.

    • supportsSubtaskQuery

      boolean supportsSubtaskQuery()
      Tests if an IssueQuery is available.
      Returns:
      true if a subtask issue query is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getSubtaskQuery

      IssueQuery getSubtaskQuery()
      Gets the query for a subtask issue. Multiple retrievals produce a nested OR term.
      Returns:
      the subtask issue query
      Throws:
      UnimplementedException - supportsSubtaskQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsSubtaskQuery()} is {@code true} .

    • matchAnySubtask

      void matchAnySubtask(boolean match)
      Matches issues that have any subtask.
      Parameters:
      match - true to match issues with any subtasks, false to match issues on no subtasks
      Compliance:
      mandatory - This method must be implemented.

    • clearSubtaskTerms

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

    • matchMasterIssueId

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

    • clearMasterIssueIdTerms

      void clearMasterIssueIdTerms()
      Clears the master issue issue Id query terms.
      Compliance:
      mandatory - This method must be implemented.

    • supportsMasterIssueQuery

      boolean supportsMasterIssueQuery()
      Tests if an IssueQuery is available.
      Returns:
      true if a master issue query is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getMasterIssueQuery

      IssueQuery getMasterIssueQuery()
      Gets the query for a master issue. Multiple retrievals produce a nested OR term.
      Returns:
      the master issue query
      Throws:
      UnimplementedException - supportsMasterIssueQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsMasterIssueQuery()} is {@code true} .

    • matchAnyMasterIssue

      void matchAnyMasterIssue(boolean match)
      Matches issues that are subtasks.
      Parameters:
      match - true to match issues with any master issue, false to match issues on no master issues
      Compliance:
      mandatory - This method must be implemented.

    • clearMasterIssueTerms

      void clearMasterIssueTerms()
      Clears the linked issue query terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchDuplicateIssueId

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

    • clearDuplicateIssueIdTerms

      void clearDuplicateIssueIdTerms()
      Clears the duplicate issue issue Id query terms.
      Compliance:
      mandatory - This method must be implemented.

    • supportsDuplicateIssueQuery

      boolean supportsDuplicateIssueQuery()
      Tests if an IssueQuery is available.
      Returns:
      true if a duplicate issue query is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getDuplicateIssueQuery

      IssueQuery getDuplicateIssueQuery()
      Gets the query for a duplicate issue. Multiple retrievals produce a nested OR term.
      Returns:
      the duplicate issue query
      Throws:
      UnimplementedException - supportsDuplicateIssueQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsDuplicateIssueQuery()} is {@code true} .

    • matchAnyDuplicateIssue

      void matchAnyDuplicateIssue(boolean match)
      Matches issues that are duplicated by any other issue.
      Parameters:
      match - true to match duplicate issues, false to match unlinked issues
      Compliance:
      mandatory - This method must be implemented.

    • clearDuplicateIssueTerms

      void clearDuplicateIssueTerms()
      Clears the duplicate issue query terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchBranchedIssueId

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

    • clearBranchedIssueIdTerms

      void clearBranchedIssueIdTerms()
      Clears the branched issue issue Id query terms.
      Compliance:
      mandatory - This method must be implemented.

    • supportsBranchedIssueQuery

      boolean supportsBranchedIssueQuery()
      Tests if an IssueQuery is available.
      Returns:
      true if a branched issue query is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getBranchedIssueQuery

      IssueQuery getBranchedIssueQuery()
      Gets the query for a branched issue. Multiple retrievals produce a nested OR term.
      Returns:
      the branched issue query
      Throws:
      UnimplementedException - supportsBranchedIssueQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsBranchedIssueQuery()} is {@code true} .

    • matchAnyBranchedIssue

      void matchAnyBranchedIssue(boolean match)
      Matches issues that branched to any other issue.
      Parameters:
      match - true to match issues with branches, false to match issues with no branches
      Compliance:
      mandatory - This method must be implemented.

    • clearBranchedIssueTerms

      void clearBranchedIssueTerms()
      Clears the branched issue query terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchRootIssueId

      void matchRootIssueId(Id issueId, boolean match)
      Sets the root of the branch issue Id for this query.
      Parameters:
      issueId - the issue Id
      match - true for a positive match, false for a negative match
      Throws:
      NullArgumentException - issueId is null
      Compliance:
      mandatory - This method must be implemented.

    • clearRootIssueIdTerms

      void clearRootIssueIdTerms()
      Clears the root issue issue Id query terms.
      Compliance:
      mandatory - This method must be implemented.

    • supportsRootIssueQuery

      boolean supportsRootIssueQuery()
      Tests if an IssueQuery is available.
      Returns:
      true if a root issue query is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getRootIssueQuery

      IssueQuery getRootIssueQuery()
      Gets the query for a root of the branch issue. Multiple retrievals produce a nested OR term.
      Returns:
      the root issue query
      Throws:
      UnimplementedException - supportsRootIssueQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsRootIssueQuery()} is {@code true} .

    • matchAnyRootIssue

      void matchAnyRootIssue(boolean match)
      Matches issue branches with a root.
      Parameters:
      match - true to match branches with a root, false to match issues that are not a branch of another issue
      Compliance:
      mandatory - This method must be implemented.

    • clearRootIssueTerms

      void clearRootIssueTerms()
      Clears the root issue query terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchPriorityType

      void matchPriorityType(Type priorityType, boolean match)
      Matches issues with the given priority type.
      Parameters:
      priorityType - the priority Type
      match - true for a positive match, false for a negative match
      Throws:
      NullArgumentException - priorityType is null
      Compliance:
      mandatory - This method must be implemented.

    • clearPriorityTypeTerms

      void clearPriorityTypeTerms()
      Clears the priority type query terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchCreatorId

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

    • clearCreatorIdTerms

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

    • supportsCreatorQuery

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

    • getCreatorQuery

      ResourceQuery getCreatorQuery()
      Gets the query for a creator. Multiple retrievals produce a nested OR term.
      Returns:
      the resource query
      Throws:
      UnimplementedException - supportsCreatorQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsCreatorQuery()} is {@code true} .

    • clearCreatorTerms

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

    • matchCreatingAgentId

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

    • clearCreatingAgentIdTerms

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

    • supportsCreatingAgentQuery

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

    • getCreatingAgentQuery

      AgentQuery getCreatingAgentQuery()
      Gets the query for a creator. Multiple retrievals produce a nested OR term.
      Returns:
      the agent query
      Throws:
      UnimplementedException - supportsCreatingAgentQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsCreatingAgentQuery()} is {@code true} .

    • clearCreatingAgentTerms

      void clearCreatingAgentTerms()
      Clears the creating agent query terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchCreatedDate

      void matchCreatedDate(DateTime from, DateTime to, boolean match)
      Matches issues created within the given date range inclusive.
      Parameters:
      from - the range start
      to - the range end
      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.

    • clearCreatedDateTerms

      void clearCreatedDateTerms()
      Clears the created date query terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchReopenerId

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

    • clearReopenerIdTerms

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

    • supportsReopenerQuery

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

    • getReopenerQuery

      ResourceQuery getReopenerQuery()
      Gets the query for the resource who reopened this issue. Multiple retrievals produce a nested OR term.
      Returns:
      the resource query
      Throws:
      UnimplementedException - supportsReopenerQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsReopenerQuery()} is {@code true} .

    • clearReopenerTerms

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

    • matchReopeningAgentId

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

    • clearReopeningAgentIdTerms

      void clearReopeningAgentIdTerms()
      Clears the reopening agent Id query terms.
      Compliance:
      mandatory - This method must be implemented.

    • supportsReopeningAgentQuery

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

    • getReopeningAgentQuery

      AgentQuery getReopeningAgentQuery()
      Gets the query for the agent who reopened this issue. Multiple retrievals produce a nested OR term.
      Returns:
      the agent query
      Throws:
      UnimplementedException - supportsReopeningAgentQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsReopeningAgentQuery()} is {@code true} .

    • clearReopeningAgentTerms

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

    • matchReopenedDate

      void matchReopenedDate(DateTime from, DateTime to, boolean match)
      Matches issues reopened within the given date range inclusive.
      Parameters:
      from - the range start
      to - the range end
      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.

    • matchAnyReopenedDate

      void matchAnyReopenedDate(boolean match)
      Matches issues that have any reopened date.
      Parameters:
      match - true to match issues with any reopened date, false to match issues with no reopened date
      Compliance:
      mandatory - This method must be implemented.

    • clearReopenedDateTerms

      void clearReopenedDateTerms()
      Clears the reopened date query terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchDueDate

      void matchDueDate(DateTime from, DateTime to, boolean match)
      Matches issue due dates within the given date range inclusive.
      Parameters:
      from - the range start
      to - the range end
      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.

    • matchAnyDueDate

      void matchAnyDueDate(boolean match)
      Matches issues that have any due date.
      Parameters:
      match - true to match issues with any due date, false to match issues with no due date
      Compliance:
      mandatory - This method must be implemented.

    • clearDueDateTerms

      void clearDueDateTerms()
      Clears the due date query terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchPending

      void matchPending(boolean match)
      Matches issues that are pending a customer response.
      Parameters:
      match - true to match pending issues, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • clearPendingTerms

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

    • matchBlockingIssueId

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

    • clearBlockingIssueIdTerms

      void clearBlockingIssueIdTerms()
      Clears the blocking issue issue Id query terms.
      Compliance:
      mandatory - This method must be implemented.

    • supportsBlockingIssueQuery

      boolean supportsBlockingIssueQuery()
      Tests if an IssueQuery is available.
      Returns:
      true if a blocking issue query is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getBlockingIssueQuery

      IssueQuery getBlockingIssueQuery()
      Gets the query for a blocking issue. Multiple retrievals produce a nested OR term.
      Returns:
      the blocking issue query
      Throws:
      UnimplementedException - supportsBlockingIssueQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsBlockingIssueQuery()} is {@code true} .

    • matchAnyBlockingIssue

      void matchAnyBlockingIssue(boolean match)
      Matches any blocking issue.
      Parameters:
      match - true to match blocking issues, false to match issues not blocking
      Compliance:
      mandatory - This method must be implemented.

    • clearBlockingIssueTerms

      void clearBlockingIssueTerms()
      Clears the blocking issue query terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchBlockedIssueId

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

    • clearBlockedIssueIdTerms

      void clearBlockedIssueIdTerms()
      Clears the blocked issue issue Id query terms.
      Compliance:
      mandatory - This method must be implemented.

    • supportsBlockedIssueQuery

      boolean supportsBlockedIssueQuery()
      Tests if an IssueQuery is available.
      Returns:
      true if a blocked issue query is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getBlockedIssueQuery

      IssueQuery getBlockedIssueQuery()
      Gets the query for a blocked issue. Multiple retrievals produce a nested OR term.
      Returns:
      the blocking issue query
      Throws:
      UnimplementedException - supportsBlockedIssueQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsBlockedIssueQuery()} is {@code true} .

    • matchAnyBlockedIssue

      void matchAnyBlockedIssue(boolean match)
      Matches any issue blocked.
      Parameters:
      match - true to match issues blocked, false to match issues that are not blocked
      Compliance:
      mandatory - This method must be implemented.

    • clearBlockedIssueTerms

      void clearBlockedIssueTerms()
      Clears the blocked issue query terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchResolverId

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

    • clearResolverIdTerms

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

    • supportsResolverQuery

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

    • getResolverQuery

      ResourceQuery getResolverQuery()
      Gets the query for the resource who resolved this issue. Multiple retrievals produce a nested OR term.
      Returns:
      the resource query
      Throws:
      UnimplementedException - supportsResolverQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsResolverQuery()} is {@code true} .

    • clearResolverTerms

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

    • matchResolvingAgentId

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

    • clearResolvingAgentIdTerms

      void clearResolvingAgentIdTerms()
      Clears the resolving agent Id query terms.
      Compliance:
      mandatory - This method must be implemented.

    • supportsResolvingAgentQuery

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

    • getResolvingAgentQuery

      AgentQuery getResolvingAgentQuery()
      Gets the query for the agent who resolved this issue. Multiple retrievals produce a nested OR term.
      Returns:
      the agent query
      Throws:
      UnimplementedException - supportsResolvingAgentQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsResolvingAgentQuery()} is {@code true} .

    • clearResolvingAgentTerms

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

    • matchResolvedDate

      void matchResolvedDate(DateTime from, DateTime to, boolean match)
      Matches issue resolved dates within the given date range inclusive.
      Parameters:
      from - the range start
      to - the range end
      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.

    • matchAnyResolvedDate

      void matchAnyResolvedDate(boolean match)
      Matches any issue that has been resolved.
      Parameters:
      match - true to match resolved issues, false to match unresolved issues
      Compliance:
      mandatory - This method must be implemented.

    • clearResolvedDateTerms

      void clearResolvedDateTerms()
      Clears the resolved date query terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchResolutionType

      void matchResolutionType(Type resolutionType, boolean match)
      Matches issues with the given resolution type.
      Parameters:
      resolutionType - the resolution Type
      match - true for a positive match, false for a negative match
      Throws:
      NullArgumentException - resolutionType is null
      Compliance:
      mandatory - This method must be implemented.

    • clearResolutionTypeTerms

      void clearResolutionTypeTerms()
      Clears the resolution type query terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchCloserId

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

    • clearCloserIdTerms

      void clearCloserIdTerms()
      Clears the closer resource Id query terms.
      Compliance:
      mandatory - This method must be implemented.

    • supportsCloserQuery

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

    • getCloserQuery

      ResourceQuery getCloserQuery()
      Gets the query for the agent who closed this issue. Multiple retrievals produce a nested OR term.
      Returns:
      the resource query
      Throws:
      UnimplementedException - supportsCloserQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsCloserQuery()} is {@code true} .

    • clearCloserTerms

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

    • matchClosingAgentId

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

    • clearClosingAgentIdTerms

      void clearClosingAgentIdTerms()
      Clears the closing agent Id query terms.
      Compliance:
      mandatory - This method must be implemented.

    • supportsClosingAgentQuery

      boolean supportsClosingAgentQuery()
      Tests if an AgentQuery is available.
      Returns:
      true if a closing agent query is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getClosingAgentQuery

      AgentQuery getClosingAgentQuery()
      Gets the query for the agent who closed this issue. Multiple retrievals produce a nested OR term.
      Returns:
      the agent query
      Throws:
      UnimplementedException - supportsClosingAgentQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsClosingAgentQuery()} is {@code true} .

    • clearClosingAgentTerms

      void clearClosingAgentTerms()
      Clears the closing agent query terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchClosedDate

      void matchClosedDate(DateTime from, DateTime to, boolean match)
      Matches issue closed dates within the given date range inclusive.
      Parameters:
      from - the range start
      to - the range end
      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.

    • matchAnyClosedDate

      void matchAnyClosedDate(boolean match)
      Matches any issue that has been closed.
      Parameters:
      match - true to match closed issues, false to match unclosed issues
      Compliance:
      mandatory - This method must be implemented.

    • clearClosedDateTerms

      void clearClosedDateTerms()
      Clears the closed date query terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchAssignedResourceId

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

    • clearAssignedResourceIdTerms

      void clearAssignedResourceIdTerms()
      Clears the currently assigned resource Id query terms.
      Compliance:
      mandatory - This method must be implemented.

    • supportsAssignedResourceQuery

      boolean supportsAssignedResourceQuery()
      Tests if a ResourceQuery is available.
      Returns:
      true if an assigned resource query is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getAssignedResourceQuery

      ResourceQuery getAssignedResourceQuery()
      Gets the query for the current assigned resource. Multiple retrievals produce a nested OR term.
      Returns:
      the resource query
      Throws:
      UnimplementedException - supportsAssignedResourceQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsAssignedResourceQuery()} is {@code true} .

    • matchAnyAssignedResource

      void matchAnyAssignedResource(boolean match)
      Matches any issue that has any current assigned resource.
      Parameters:
      match - true to match issues with any currently assigned resource, false to match issues with no currently assigned resource
      Compliance:
      mandatory - This method must be implemented.

    • clearAssignedResourceTerms

      void clearAssignedResourceTerms()
      Clears the current assigned resource query terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchResourceId

      void matchResourceId(Id resourceId, boolean match)
      Sets the resource Id for this query to match any resource ever assigned to an issue.
      Parameters:
      resourceId - the resource Id
      match - true for a positive match, false for a negative match
      Throws:
      NullArgumentException - resourceId is null
      Compliance:
      mandatory - This method must be implemented.

    • clearResourceIdTerms

      void clearResourceIdTerms()
      Clears the assigned resource Id query terms.
      Compliance:
      mandatory - This method must be implemented.

    • supportsResourceQuery

      boolean supportsResourceQuery()
      Tests if a ResourceQuery is available.
      Returns:
      true if an assigned resource query is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getResourceQuery

      ResourceQuery getResourceQuery()
      Gets the query for the assigned resource. Multiple retrievals produce a nested OR term.
      Returns:
      the resource query
      Throws:
      UnimplementedException - supportsResourceQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsResourceQuery()} is {@code true} .

    • matchAnyResource

      void matchAnyResource(boolean match)
      Matches any issue that has any assigned resource.
      Parameters:
      match - true to match issues with any resource ever assigned, false to match issues that never had an assigned resource
      Compliance:
      mandatory - This method must be implemented.

    • clearResourceTerms

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

    • matchLogEntryId

      void matchLogEntryId(Id logEntryId, boolean match)
      Sets the log entry Id for this query to match issues along the given log entry.
      Parameters:
      logEntryId - the log entry Id
      match - true for a positive match, false for a negative match
      Throws:
      NullArgumentException - logEntryId is null
      Compliance:
      mandatory - This method must be implemented.

    • clearLogEntryIdTerms

      void clearLogEntryIdTerms()
      Clears the log entry Id query terms.
      Compliance:
      mandatory - This method must be implemented.

    • supportsLogEntryQuery

      boolean supportsLogEntryQuery()
      Tests if a LogEntryQuery is available.
      Returns:
      true if a log entry query is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getLogEntryQuery

      LogEntryQuery getLogEntryQuery()
      Gets the query for a log entry. Multiple retrievals produce a nested OR term.
      Returns:
      the log entry query
      Throws:
      UnimplementedException - supportsLogEntryQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsLogEntryQuery()} is {@code true} .

    • matchAnyLogEntry

      void matchAnyLogEntry(boolean match)
      Matches issues that are used on any log entry.
      Parameters:
      match - true to match issues with any log entry, false to match issues with no log entries
      Compliance:
      mandatory - This method must be implemented.

    • clearLogEntryTerms

      void clearLogEntryTerms()
      Clears the log entry query terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchFrontOfficeId

      void matchFrontOfficeId(Id frontOfficeId, boolean match)
      Sets the front office Id for this query to match issues assigned to front offices.
      Parameters:
      frontOfficeId - the front office Id
      match - true for a positive match, false for a negative match
      Throws:
      NullArgumentException - frontOfficeId is null
      Compliance:
      mandatory - This method must be implemented.

    • clearFrontOfficeIdTerms

      void clearFrontOfficeIdTerms()
      Clears the front office Id query terms.
      Compliance:
      mandatory - This method must be implemented.

    • supportsFrontOfficeQuery

      boolean supportsFrontOfficeQuery()
      Tests if a FrontOfficeQuery is available.
      Returns:
      true if a front office query is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getFrontOfficeQuery

      FrontOfficeQuery getFrontOfficeQuery()
      Gets the query for a front office. Multiple retrievals produce a nested OR term.
      Returns:
      the front office query
      Throws:
      UnimplementedException - supportsFrontOfficeQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsFrontOfficeQuery()} is {@code true} .

    • clearFrontOfficeTerms

      void clearFrontOfficeTerms()
      Clears the front office query terms.
      Compliance:
      mandatory - This method must be implemented.

    • getIssueQueryRecord

      IssueQueryRecord getIssueQueryRecord(Type issueRecordType) throws OperationFailedException
      Gets the issue query record corresponding to the given Issue record Type .Multiple record retrievals produce a nested OR term.
      Parameters:
      issueRecordType - a issue record type
      Returns:
      the issue query record
      Throws:
      NullArgumentException - issueRecordType is null
      OperationFailedException - unable to complete request
      UnsupportedException - hasRecordType(issueRecordType) is false
      Compliance:
      mandatory - This method must be implemented.