Interface ValueQuery

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

The interface to query a value.

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

  • Method Details

    • matchPriority

      void matchPriority(long low, long high, boolean match)
      Adds a priority match. Multiple ranges can be added to perform a boolean OR among them.
      Parameters:
      low - start priority value
      high - end priority value
      match - true if a positive match, false for a negative match
      Compliance:
      mandatory - This method must be implemented.

    • matchAnyPriority

      void matchAnyPriority(boolean match)
      Matches values with any priority.
      Parameters:
      match - true if to match values with any priority, false to match values with no priority
      Compliance:
      mandatory - This method must be implemented.

    • clearPriorityTerms

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

    • matchBooleanValue

      void matchBooleanValue(boolean value, boolean match)
      Adds a boolean match.
      Parameters:
      value - a boolean value
      match - true if a positive match, false for a negative match
      Compliance:
      mandatory - This method must be implemented.

    • clearBooleanValueTerms

      void clearBooleanValueTerms()
      Clears the boolean value terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchBytesValue

      void matchBytesValue(byte[] value, boolean match, boolean partial)
      Adds a byte string match. Multiple byte arrays can be added to perform a boolean OR among them.
      Parameters:
      value - a byte value
      match - true if a positive match, false for a negative match
      partial - true if for a partial match, false for complete match
      Compliance:
      mandatory - This method must be implemented.

    • clearBytesValueTerms

      void clearBytesValueTerms()
      Clears the bytes value terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchCardinalValue

      void matchCardinalValue(long low, long high, boolean match)
      Adds a cardinal match within the given range inclusive. Multiple ranges can be added to perform a boolean OR among them.
      Parameters:
      low - start cardinal value
      high - end cardinal value
      match - true if a positive match, false for a negative match
      Compliance:
      mandatory - This method must be implemented.

    • clearCardinalValueTerms

      void clearCardinalValueTerms()
      Clears the cardinal value terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchCoordinateType

      void matchCoordinateType(Type coordinateType, boolean match)
      Matches values for a coordinate type.
      Parameters:
      coordinateType - a coordinate type
      match - true if a positive match, false for a negative match
      Throws:
      NullArgumentException - coordinateType is null
      Compliance:
      mandatory - This method must be implemented.

    • clearCoordinateTypeTerms

      void clearCoordinateTypeTerms()
      Clears the coordinate type terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchCoordinateValue

      void matchCoordinateValue(Coordinate coordinate, boolean match)
      Adds a coordinate match for coordinates inside the specified coordinate. Multiple ranges can be added to perform a boolean OR among them.
      Parameters:
      coordinate - a coordinate value
      match - true if a positive match, false for a negative match
      Throws:
      NullArgumentException - coordinate is null
      Compliance:
      mandatory - This method must be implemented.

    • clearCoordinateValueTerms

      void clearCoordinateValueTerms()
      Clears the coordinate value terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchCurrencyType

      void matchCurrencyType(Type currencyType, boolean match)
      Matches values for a currency type.
      Parameters:
      currencyType - a currency type
      match - true if a positive match, false for a negative match
      Throws:
      NullArgumentException - currencyType is null
      Compliance:
      mandatory - This method must be implemented.

    • clearCurrencyTypeTerms

      void clearCurrencyTypeTerms()
      Clears the currency type terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchCurrencyValue

      void matchCurrencyValue(Currency low, Currency high, boolean match)
      Adds a currency match within the given range inclusive. Multiple ranges can be added to perform a boolean OR among them.
      Parameters:
      low - start currency value
      high - a currency value
      match - true if a positive match, false for a negative match
      Throws:
      InvalidArgumentException - low is greater than high
      NullArgumentException - low or high is null
      Compliance:
      mandatory - This method must be implemented.

    • clearCurrencyValueTerms

      void clearCurrencyValueTerms()
      Clears the currency value terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchCalendarType

      void matchCalendarType(Type calendarType, boolean match)
      Matches values for a calendar type.
      Parameters:
      calendarType - a calendar type
      match - true if a positive match, false for a negative match
      Throws:
      NullArgumentException - calendarType is null
      Compliance:
      mandatory - This method must be implemented.

    • clearCalendarTypeTerms

      void clearCalendarTypeTerms()
      Clears the calendar type terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchTimeType

      void matchTimeType(Type timeType, boolean match)
      Matches values for a time type.
      Parameters:
      timeType - a time type
      match - true if a positive match, false for a negative match
      Throws:
      NullArgumentException - timeType is null
      Compliance:
      mandatory - This method must be implemented.

    • clearTimeTypeTerms

      void clearTimeTypeTerms()
      Clears the time type terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchDateTimeValue

      void matchDateTimeValue(DateTime low, DateTime high, boolean match)
      Adds a DateTime range match within the given range inclusive. Multiple ranges can be added to perform a boolean OR among them.
      Parameters:
      low - start datetime value
      high - end datetime value
      match - true if a positive match, false for a negative match
      Throws:
      InvalidArgumentException - low is greater than high
      NullArgumentException - low or high is null
      Compliance:
      mandatory - This method must be implemented.

    • clearDateTimeValueTerms

      void clearDateTimeValueTerms()
      Clears the date time value terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchDecimalValue

      void matchDecimalValue(BigDecimal low, BigDecimal high, boolean match)
      Adds a decimal match within the given range inclusive. Multiple ranges can be added to perform a boolean OR among them.
      Parameters:
      low - start decimal value
      high - end decimal value
      match - true if a positive match, false for a negative match
      Compliance:
      mandatory - This method must be implemented.

    • clearDecimalValueTerms

      void clearDecimalValueTerms()
      Clears the decimal value terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchLanguageType

      void matchLanguageType(Type languageType, boolean match)
      Matches values for a language type.
      Parameters:
      languageType - a language type
      match - true if a positive match, false for a negative match
      Throws:
      NullArgumentException - languageType is null
      Compliance:
      mandatory - This method must be implemented.

    • clearLanguageTypeTerms

      void clearLanguageTypeTerms()
      Clears the language type terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchScriptType

      void matchScriptType(Type scriptType, boolean match)
      Matches values for a script type.
      Parameters:
      scriptType - a script type
      match - true if a positive match, false for a negative match
      Throws:
      NullArgumentException - scriptType is null
      Compliance:
      mandatory - This method must be implemented.

    • clearScriptTypeTerms

      void clearScriptTypeTerms()
      Clears the script type terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchFormatType

      void matchFormatType(Type formatType, boolean match)
      Matches values for a format type.
      Parameters:
      formatType - a format type
      match - true if a positive match, false for a negative match
      Throws:
      NullArgumentException - formatType is null
      Compliance:
      mandatory - This method must be implemented.

    • clearFormatTypeTerms

      void clearFormatTypeTerms()
      Clears the format type terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchDistanceValue

      void matchDistanceValue(Distance low, Distance high, boolean match)
      Adds a Distance range match within the given range inclusive. Multiple ranges can be added to perform a boolean OR among them.
      Parameters:
      low - start distance value
      high - end distance value
      match - true if a positive match, false for a negative match
      Throws:
      InvalidArgumentException - low is greater than high
      NullArgumentException - low or high is null
      Compliance:
      mandatory - This method must be implemented.

    • clearDistanceValueTerms

      void clearDistanceValueTerms()
      Clears the distance value terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchDurationValue

      void matchDurationValue(Duration low, Duration high, boolean match)
      Adds a Duration range match within the given range inclusive. Multiple ranges can be added to perform a boolean OR among them.
      Parameters:
      low - start duration value
      high - end duration value
      match - true if a positive match, false for a negative match
      Throws:
      InvalidArgumentException - low is greater than high
      NullArgumentException - low or high is null
      Compliance:
      mandatory - This method must be implemented.

    • clearDurationValueTerms

      void clearDurationValueTerms()
      Clears the duration value terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchHeadingType

      void matchHeadingType(Type headingType, boolean match)
      Matches values for a heading type.
      Parameters:
      headingType - a heading type
      match - true if a positive match, false for a negative match
      Throws:
      NullArgumentException - headingType is null
      Compliance:
      mandatory - This method must be implemented.

    • clearHeadingTypeTerms

      void clearHeadingTypeTerms()
      Clears the heading type terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchHeadingValue

      void matchHeadingValue(Heading low, Heading high, boolean match)
      Adds a Heading range match within the given range inclusive. Multiple ranges can be added to perform a boolean OR among them.
      Parameters:
      low - start heading value
      high - end heading value
      match - true if a positive match, false for a negative match
      Throws:
      InvalidArgumentException - low is greater than high
      NullArgumentException - low or high is null
      Compliance:
      mandatory - This method must be implemented.

    • clearHeadingValueTerms

      void clearHeadingValueTerms()
      Clears the heading value terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchIdValue

      void matchIdValue(Id value, boolean match)
      Adds an Id to match. Multiple Ids can be added to perform a boolean OR among them.
      Parameters:
      value - an Id value
      match - true if a positive match, false for a negative match
      Throws:
      NullArgumentException - value is null
      Compliance:
      mandatory - This method must be implemented.

    • clearIdValueTerms

      void clearIdValueTerms()
      Clears the Id value terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchIntegerValue

      void matchIntegerValue(long low, long high, boolean match)
      Adds an integer match within the given range inclusive. Multiple ranges can be added to perform a boolean OR among them.
      Parameters:
      low - start integer value
      high - end integer value
      match - true if a positive match, false for a negative match
      Compliance:
      mandatory - This method must be implemented.

    • clearIntegerValueTerms

      void clearIntegerValueTerms()
      Clears the integer value terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchSpatialUnitValue

      void matchSpatialUnitValue(SpatialUnit value, boolean match)
      Adds a spatial unit match within the given spatial unit inclusive. Multiple ranges can be added to perform a boolean OR among them.
      Parameters:
      value - a spatial unit
      match - true if a positive match, false for a negative match
      Throws:
      NullArgumentException - value is null
      Compliance:
      mandatory - This method must be implemented.

    • clearSpatialUnitValueTerms

      void clearSpatialUnitValueTerms()
      Clears the spatial unit value terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchSpeedValue

      void matchSpeedValue(Speed low, Speed high, boolean match)
      Adds a speed match within the given range inclusive. Multiple ranges can be added to perform a boolean OR among them.
      Parameters:
      low - start speed value
      high - end speed value
      match - true if a positive match, false for a negative match
      Throws:
      InvalidArgumentException - low is greater than high
      NullArgumentException - low or high is null
      Compliance:
      mandatory - This method must be implemented.

    • clearSpeedValueTerms

      void clearSpeedValueTerms()
      Clears the speed value terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchStringValue

      void matchStringValue(String value, Type stringMatchType, boolean match)
      Adds a string match. Multiple strings can be added to perform a boolean OR among them.
      Parameters:
      value - string to match
      stringMatchType - the string match type
      match - true for a positive match, false for a negative match
      Throws:
      InvalidArgumentException - value is not of stringMatchType
      NullArgumentException - value or stringMatchType is null
      UnsupportedException - supportsStringMatchType(stringMatchType) is false
      Compliance:
      mandatory - This method must be implemented.

    • clearStringValueTerms

      void clearStringValueTerms()
      Clears the string value terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchTimeValue

      void matchTimeValue(Time low, Time high, boolean match)
      Adds a time match within the given range inclusive. Multiple ranges can be added to perform a boolean OR among them.
      Parameters:
      low - start time value
      high - end time value
      match - true if a positive match, false for a negative match
      Throws:
      InvalidArgumentException - low is greater than high
      NullArgumentException - low or high is null
      Compliance:
      mandatory - This method must be implemented.

    • clearTimeValueTerms

      void clearTimeValueTerms()
      Clears the time value terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchTypeValue

      void matchTypeValue(Type value, boolean match)
      Adds a Type match. Multiple types can be added to perform a boolean OR among them.
      Parameters:
      value - type to match
      match - true for a positive match, false for a negative match
      Throws:
      NullArgumentException - value is null
      Compliance:
      mandatory - This method must be implemented.

    • clearTypeValueTerms

      void clearTypeValueTerms()
      Clears the type value terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchVersionScheme

      void matchVersionScheme(Type scheme, boolean match)
      Metahces values of a version scheme type.
      Parameters:
      scheme - scheme to match
      match - true for a positive match, false for a negative match
      Throws:
      NullArgumentException - scheme is null
      Compliance:
      mandatory - This method must be implemented.

    • clearVersionSchemeTerms

      void clearVersionSchemeTerms()
      Clears the version scheme terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchVersionValue

      void matchVersionValue(Version low, Version high, boolean match)
      Adds a Version match within the given range inclusive. Multiple queries can be added to perform a boolean OR among them.
      Parameters:
      low - start version value
      high - end version value
      match - true if a positive match, false for a negative match
      Throws:
      InvalidArgumentException - low is greater than high
      NullArgumentException - low or high is null
      Compliance:
      mandatory - This method must be implemented.

    • clearVersionValueTerms

      void clearVersionValueTerms()
      Clears the version value terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchObjectType

      void matchObjectType(Type objectType, boolean match)
      Adds a Type to match on the type of object. Multiple types can be added to perform a boolean OR among them.
      Parameters:
      objectType - type to match
      match - true for a positive match, false for a negative match
      Throws:
      NullArgumentException - objectType is null
      Compliance:
      mandatory - This method must be implemented.

    • clearObjectTypeTerms

      void clearObjectTypeTerms()
      Clears the object type value terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchObjectValue

      void matchObjectValue(Object object, Type objectType, boolean match)
      Adds an object match. Multiple objects can be added to perform a boolean OR among them.
      Parameters:
      object - object to match
      objectType - type of object
      match - true for a positive match, false for a negative match
      Throws:
      NullArgumentException - object or objectType is null
      Compliance:
      mandatory - This method must be implemented.

    • clearObjectValueTerms

      void clearObjectValueTerms()
      Clears the object value terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchObjectValueType

      void matchObjectValueType(Type objectType, boolean match)
      Adds a Type to match on the type of object. Multiple types can be added to perform a boolean OR among them.
      Parameters:
      objectType - type to match
      match - true for a positive match, false for a negative match
      Throws:
      NullArgumentException - objectType is null
      Compliance:
      mandatory - This method must be implemented.

    • clearObjectValueTypeTerms

      void clearObjectValueTypeTerms()
      Clears the object value type value terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchParameterId

      void matchParameterId(Id parameterId, boolean match)
      Adds a parameter Id for this query.
      Parameters:
      parameterId - a parameter Id
      match - true if a positive match, false for a negative match
      Throws:
      NullArgumentException - parameterId is null
      Compliance:
      mandatory - This method must be implemented.

    • clearParameterIdTerms

      void clearParameterIdTerms()
      Clears the parameter Id terms.
      Compliance:
      mandatory - This method must be implemented.

    • supportsParameterQuery

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

    • getParameterQuery

      ParameterQuery getParameterQuery()
      Gets the query for a parameter.
      Returns:
      the parameter query
      Throws:
      UnimplementedException - supportsParameterQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsParameterQuery()} is {@code true}.

    • clearParameterTerms

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

    • matchConfigurationId

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

    • clearConfigurationIdTerms

      void clearConfigurationIdTerms()
      Clears the configuration Id terms.
      Compliance:
      mandatory - This method must be implemented.

    • supportsConfigurationQuery

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

    • getConfigurationQuery

      ConfigurationQuery getConfigurationQuery()
      Gets the query for a configuration.
      Returns:
      the configuration query
      Throws:
      UnimplementedException - supportsConfigurationQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsConfigurationQuery()} is {@code true}.

    • clearConfigurationTerms

      void clearConfigurationTerms()
      Clears the configuration Id terms.
      Compliance:
      mandatory - This method must be implemented.

    • getValueQueryRecord

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