Interface WorkflowEventQuery

All Superinterfaces:
Extensible, OsidBrowsableQuery, OsidExtensibleQuery, OsidIdentifiableQuery, OsidObjectQuery, OsidQuery, Suppliable
public interface WorkflowEventQuery extends OsidObjectQuery

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

  • Method Details

    • matchTimestamp

      void matchTimestamp(DateTime start, DateTime end, boolean match)
      Matches temporals whose timestamp falls in between the given dates inclusive.
      Parameters:
      start - start of date range
      end - end of date range
      match - true if a positive match, false for a negative match
      Throws:
      InvalidArgumentException - start is less than end
      NullArgumentException - start or end is null
      Compliance:
      mandatory - This method must be implemented.

    • clearTimestampTerms

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

    • matchProcessId

      void matchProcessId(Id processId, boolean match)
      Sets the process Id for this query to match workflow events for processes.
      Parameters:
      processId - the process Id
      match - true for a positive match, false for a negative match
      Throws:
      NullArgumentException - processId is null
      Compliance:
      mandatory - This method must be implemented.

    • clearProcessIdTerms

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

    • supportsProcessQuery

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

    • getProcessQuery

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

    • clearProcessTerms

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

    • matchWorkerId

      void matchWorkerId(Id resourceId, boolean match)
      Sets the worker Id for this query to match workers.
      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.

    • clearWorkerIdTerms

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

    • supportsWorkerQuery

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

    • getWorkerQuery

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

    • clearWorkerTerms

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

    • matchWorkingAgentId

      void matchWorkingAgentId(Id agentId, boolean match)
      Sets the agent Id for this query to match working agents.
      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.

    • clearWorkingAgentIdTerms

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

    • supportsWorkingAgentQuery

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

    • getWorkingAgentQuery

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

    • clearWorkingAgentTerms

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

    • matchWorkId

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

    • clearWorkIdTerms

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

    • supportsWorkQuery

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

    • getWorkQuery

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

    • clearWorkTerms

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

    • matchCanceled

      void matchCanceled(boolean match)
      Matches work that has been canceled.
      Parameters:
      match - true for a positive match, false for a negative match
      Throws:
      NullArgumentException - workId is null
      Compliance:
      mandatory - This method must be implemented.

    • clearCanceledTerms

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

    • matchStepId

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

    • clearStepIdTerms

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

    • supportsStepQuery

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

    • getStepQuery

      StepQuery getStepQuery()
      Gets the query for a step. Multiple retrievals produce a nested OR term.
      Returns:
      the work query
      Throws:
      UnimplementedException - supportsStepQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsStepQuery()} is {@code true} .

    • clearStepTerms

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

    • matchOfficeId

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

    • clearOfficeIdTerms

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

    • supportsOfficeQuery

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

    • getOfficeQuery

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

    • clearOfficeTerms

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

    • getWorkflowEventQueryRecord

      WorkflowEventQueryRecord getWorkflowEventQueryRecord(Type workflowEventRecordType) throws OperationFailedException
      Gets the workflow event query record corresponding to the given WorkflowEvent record Type . Multiple record retrievals produce a nested OR term.
      Parameters:
      workflowEventRecordType - a workflow event record type
      Returns:
      the workflow event query record
      Throws:
      NullArgumentException - workflowEventRecordType is null
      OperationFailedException - unable to complete request
      UnsupportedException - hasRecordType(workflowEventRecordType) is false
      Compliance:
      mandatory - This method must be implemented.