public abstract class DocumentHistoryEntry extends Object implements XMLSerializable
fields,
each field is essentially a name-value pair that describes one aspect of the entry.
See DocumentHistory for examples of creating and using this class.
Plugin writers should not extend this class.XMLSerializable.OldVersionCompatible, XMLSerializable.VersionSupportTypeROOT_ELEMENT_NAME| Modifier and Type | Method and Description |
|---|---|
abstract void |
addField(String fieldCode,
String fieldName,
String fieldValue)
Adds a
DocumentHistoryEntryField to this entry |
abstract List<DocumentHistoryEntryField> |
getFields() |
abstract List<UrnWithRevisionNumber> |
getReferencedAnnotatedDocumentsUrnAndRevisionNumbers()
Get the URN and revision numbers of the annotatedPluginDocuments referenced by this entry
|
abstract void |
setReferencedAnnotatedDocuments(String entryFieldName,
List<AnnotatedPluginDocument> documentsToReference)
Have this entry reference some other annotatedPluginDocuments that are relevant to this entry in some way.
|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitfromXML, toXMLpublic abstract List<DocumentHistoryEntryField> getFields()
fields for this entrypublic abstract void addField(String fieldCode, String fieldName, String fieldValue)
DocumentHistoryEntryField to this entryfieldCode - unique code for the fieldfieldName - human-readable name for the fieldfieldValue - human-readable value for the fieldpublic abstract void setReferencedAnnotatedDocuments(String entryFieldName, List<AnnotatedPluginDocument> documentsToReference)
entryFieldName - the fieldName for the DocumentHistoryEntryField this method creates. See DocumentHistoryEntryField.getFieldName()documentsToReference - the documents to referencepublic abstract List<UrnWithRevisionNumber> getReferencedAnnotatedDocumentsUrnAndRevisionNumbers()
setReferencedAnnotatedDocuments(String, java.util.List),
UrnWithRevisionNumber