Interface ParameterQuery

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

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

  • Method Details

    • matchTextId

      void matchTextId(Id textId, boolean match)
      Sets the text Id for this query to match presses that have a related affiliation.
      Parameters:
      textId - a text Id
      match - true if a positive match, false for negative match
      Throws:
      NullArgumentException - textId is null
      Compliance:
      mandatory - This method must be implemented.

    • clearTextIdTerms

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

    • supportsTextQuery

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

    • getTextQuery

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

    • clearTextTerms

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

    • matchSyntax

      void matchSyntax(Syntax syntax, boolean match)
      Adds a match for parameters of a given syntax. Multiple matches can be added to perform a boolean OR among them.
      Parameters:
      syntax - the parameter syntax
      match - true for a positive match, false for a negative match
      Throws:
      NullArgumentException - syntax is null
      Compliance:
      mandatory - This method must be implemented.

    • matchAnySyntax

      void matchAnySyntax(boolean match)
      Matches parameters that have any synatx.
      Parameters:
      match - true to match parameters with any synatx, false to match parameters with no synatx set
      Compliance:
      mandatory - This method must be implemented.

    • clearSyntaxTerms

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

    • matchInputPosition

      void matchInputPosition(long start, long end, boolean match)
      Matches parameters whose input position is in the given range inclusive,.
      Parameters:
      start - start of range
      end - end of range
      match - true for a positive match, false for a negative match
      Throws:
      InvalidArgumentException - start is greater than end
      Compliance:
      mandatory - This method must be implemented.

    • matchAnyInputPosition

      void matchAnyInputPosition(boolean match)
      Matches parameters with any input position set.
      Parameters:
      match - true for a positive match, false for a negative match
      Compliance:
      mandatory - This method must be implemented.

    • clearInputPositionTerms

      void clearInputPositionTerms()
      Clears the input position query terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchPressId

      void matchPressId(Id actionGroupId, boolean match)
      Sets the action group Id for this query to match parameters assigned to action groups.
      Parameters:
      actionGroupId - the action group Id
      match - true for a positive match, false for a negative match
      Throws:
      NullArgumentException - actionGroupId is null
      Compliance:
      mandatory - This method must be implemented.

    • clearPressIdTerms

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

    • supportsPressQuery

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

    • getPressQuery

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

    • clearPressTerms

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

    • getParameterQueryRecord

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