Package com.biomatters.geneious.publicapi.documents

Class DocumentHistoryEntryField

java.lang.Object
com.biomatters.geneious.publicapi.documents.DocumentHistoryEntryField
All Implemented Interfaces:
XMLSerializable
public abstract class DocumentHistoryEntryField extends 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)

  • Field Details

    • DESCRIPTION_CODE

      public static final 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:

  • Method Details

    • getFieldCode

      public abstract String getFieldCode()
      Returns:
      the code for this field

    • getFieldName

      public abstract String getFieldName()
      Returns:
      the name of this field

    • getFieldValue

      public abstract String getFieldValue()
      Returns:
      the value of this field