DocumentHistoryEntryField (Geneious Public API)

java.lang.Object
- com.biomatters.geneious.publicapi.documents.DocumentHistoryEntryField

All Implemented Interfaces:

XMLSerializable
```
public abstract class DocumentHistoryEntryField
extends java.lang.Object
implements XMLSerializable
```
A document history field is basically a name-value pair that describes one aspect of a DocumentHistoryEntry. A field is made up of: a code, which is used to uniquely identify the field; a name, which describes the field and is displayed to the user in the history viewer; and a value, which is also displayed to the user in the history viewer.
It is suggested that the class name of the plugin responsible for creating the field be used as a prefix to the fieldCode in order to ensure uniqueness of codes.
This class is immutable. Plugin writers should not extend this class.

Since:

API 4.11 (Geneious 5.0)

Nested Class Summary
- Nested classes/interfaces inherited from interface com.biomatters.geneious.publicapi.documents.XMLSerializable
  XMLSerializable.OldVersionCompatible, XMLSerializable.VersionSupportType

Field Summary

Fields
Modifier and Type Field Description

static java.lang.String DESCRIPTION_CODE
This code should be used in a field that provides a brief description for the entry.
- Fields inherited from interface com.biomatters.geneious.publicapi.documents.XMLSerializable
  ROOT_ELEMENT_NAME

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`abstract java.lang.String`	`getFieldCode()`
`abstract java.lang.String`	`getFieldName()`
`abstract java.lang.String`	`getFieldValue()`

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

Methods inherited from interface com.biomatters.geneious.publicapi.documents.XMLSerializable
fromXML, toXML

- Field Detail
  - DESCRIPTION_CODE
```
public static final java.lang.String DESCRIPTION_CODE
```
    This code should be used in a field that provides a brief description for the entry. It is treated specially by the history viewer.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - getFieldCode
```
public abstract java.lang.String getFieldCode()
```
    Returns:
    
    the code for this field
  - getFieldName
```
public abstract java.lang.String getFieldName()
```
    Returns:
    
    the name of this field
  - getFieldValue
```
public abstract java.lang.String getFieldValue()
```
    Returns:
    
    the value of this field