ValueMatch (Cyclos 4.16.19 Scripting API Documentation)

java.lang.Object
- java.lang.Enum<ValueMatch>
- - org.cyclos.model.system.fields.ValueMatch

All Implemented Interfaces:

Serializable, Comparable<ValueMatch>, HasMessageKey
```
public enum ValueMatch
extends Enum<ValueMatch>
implements HasMessageKey
```
Determines how a value is matched when searched by keywords

Enum Constant Summary

Enum Constants
Enum Constant	Description
`EXACT`	Matches for exact text
`LANGUAGE`	Matches using language analysis, such as tokenization, stop words, etc.
`TEXT`	Matches partial texts using full-text search

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`MessageKey`	`getMessageKey()`
`static ValueMatch`	`valueOf(String name)`	Returns the enum constant of this type with the specified name.
`static ValueMatch[]`	`values()`	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Enum Constant Detail
  - EXACT
```
public static final ValueMatch EXACT
```
    Matches for exact text
  - TEXT
```
public static final ValueMatch TEXT
```
    Matches partial texts using full-text search
  - LANGUAGE
```
public static final ValueMatch LANGUAGE
```
    Matches using language analysis, such as tokenization, stop words, etc.
- Method Detail
  - values
```
public static ValueMatch[] values()
```
    Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
    for (ValueMatch c : ValueMatch.values()) System.out.println(c);
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static ValueMatch valueOf(String name)
```
    Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
    
    Parameters:
    
    name - the name of the enum constant to be returned.
    
    Returns:
    
    the enum constant with the specified name
    
    Throws:
    
    IllegalArgumentException - if this enum type has no constant with the specified name
    
    NullPointerException - if the argument is null
  - getMessageKey
```
public MessageKey getMessageKey()
```
    Specified by:
    
    getMessageKey in interface HasMessageKey