ExtendedSearchOption (Geneious Public API)

java.lang.Object
- com.biomatters.geneious.publicapi.databaseservice.ExtendedSearchOption

Direct Known Subclasses:

CheckboxSearchOption, ComboboxSearchOption, DependentComboboxSearchOption, TextFieldSearchOption, TextOrSimilaritySearchOption
```
public abstract class ExtendedSearchOption
extends java.lang.Object
```
Base interface for extended search options.
Extended search options are specialized UI components which are part of the search panel for this specific service.
Do not extend this directly, but use one of the provided implementations (eg. ComboboxSearchOption)

Constructor Summary

Constructors
Modifier Constructor Description

protected ExtendedSearchOption(java.lang.String code, java.lang.String label)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`java.lang.String`	`getCode()`	Used to get the value in `Query.getExtendedOptionValue(String)`.
`java.lang.String`	`getDescription()`	Gets the description of this option to be displayed as a tooltip.
`java.lang.String`	`getLabel()`	Returns the user visible label.
`void`	`setDescription(java.lang.String description)`	Sets the description of this option to be displayed as a tooltip.
`java.lang.String`	`toString()`	Displays a summary of the properties of this option.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - ExtendedSearchOption
```
protected ExtendedSearchOption(java.lang.String code,
                               java.lang.String label)
```
- Method Detail
  - getCode
```
public java.lang.String getCode()
```
    Used to get the value in Query.getExtendedOptionValue(String).
    
    Returns:
    
    An internal code identifying the option.
  - setDescription
```
public void setDescription(java.lang.String description)
```
    Sets the description of this option to be displayed as a tooltip.
    
    Parameters:
    
    description - the description of this option
  - getDescription
```
public java.lang.String getDescription()
```
    Gets the description of this option to be displayed as a tooltip.
    
    Returns:
    
    description the description of this option
  - getLabel
```
public java.lang.String getLabel()
```
    Returns the user visible label.
    
    Returns:
    
    the user visible label
  - toString
```
public java.lang.String toString()
```
    Displays a summary of the properties of this option. The current implementation is:
    getCode() + " ("+getLabel() + " - " + getDescription() + ")"
    but this is not guaranteed to remain like this.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    a summary of the properties of this option.