Interface StepQuery

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

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

Like all OsidQueries, StepQuery is stateful and must not be accessed by multiple processing threads.

  • Method Details

    • matchProcessId

      void matchProcessId(Id processId, boolean match)
      Sets the process Id for this query.
      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.

    • matchResourceId

      void matchResourceId(Id resourceId, boolean match)
      Sets the 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.

    • clearResourceIdTerms

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

    • supportsResourceQuery

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

    • getResourceQuery

      ResourceQuery getResourceQuery()
      Gets the query for a 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 steps that have any resources.
      Parameters:
      match - true to match steps with any resources, false to match steps with no resources
      Compliance:
      mandatory - This method must be implemented.

    • clearResourceTerms

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

    • matchInitial

      void matchInitial(boolean match)
      Matches initial steps.
      Parameters:
      match - true to match initial steps, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • clearInitialTerms

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

    • matchTerminal

      void matchTerminal(boolean match)
      Matches terminal steps.
      Parameters:
      match - true to match terminal steps, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • clearTerminalTerms

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

    • matchInputStateId

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

    • clearInputStateIdTerms

      void clearInputStateIdTerms()
      Clears the input state Id query terms.
      Compliance:
      mandatory - This method must be implemented.

    • supportsInputStateQuery

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

    • getInputStateQuery

      StateQuery getInputStateQuery()
      Gets the query for an input state. Multiple retrievals produce a nested OR term.
      Returns:
      the state query
      Throws:
      UnimplementedException - supportsInputStateQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsInputtStateQuery()} is {@code true}.

    • matchAnyInputState

      void matchAnyInputState(boolean match)
      Matches steps that have any input states.
      Parameters:
      match - true to match steps with any input states, false to match steps with no input states
      Compliance:
      mandatory - This method must be implemented.

    • clearInputStateTerms

      void clearInputStateTerms()
      Clears the input state terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchNextStateId

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

    • clearNextStateIdTerms

      void clearNextStateIdTerms()
      Clears the next state Id query terms.
      Compliance:
      mandatory - This method must be implemented.

    • supportsNextStateQuery

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

    • getNextStateQuery

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

    • matchAnyNextState

      void matchAnyNextState(boolean match)
      Matches steps that have any next state,
      Parameters:
      match - true to match steps with any next state, false to match steps with no next state
      Compliance:
      mandatory - This method must be implemented.

    • clearNextStateTerms

      void clearNextStateTerms()
      Clears the state terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchWorkId

      void matchWorkId(Id workId, boolean match)
      Sets the work Id for this query.
      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}.

    • matchAnyWork

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

    • clearWorkTerms

      void clearWorkTerms()
      Clears the work 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 steps 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.

    • getStepQueryRecord

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