Package com.biomatters.geneious.publicapi.documents

Interface SummaryDocument

All Superinterfaces:

PluginDocument, XMLSerializable

public interface SummaryDocument
extends PluginDocument

Any summary document should "implement" this empty interface to enable special handling of summary documents inside Geneious. When a SummaryDocument is selected the user will be able to click a "Download" button to download the full document. At this point DatabaseService.retrieve(AnnotatedPluginDocument[], com.biomatters.geneious.publicapi.databaseservice.RetrieveCallback, URN[]) and DatabaseService.locateSummaryDocument(AnnotatedPluginDocument, AnnotatedPluginDocument[]) will be called.

In most situations, core Geneious will automatically call AnnotatedPluginDocument.setSourceService(com.biomatters.geneious.publicapi.databaseservice.DatabaseService) on the returned document so if the summary document is copied to the local documents, Geneious still knows which service to download the full document from. However, it is often a good idea for a database that returns SummaryDocuments to call this method explicitly in case the calling code bypasses the core Geneious code that sets the source service.

Nested Class Summary

Nested classes/interfaces inherited from interface com.biomatters.geneious.publicapi.documents.PluginDocument

PluginDocument.ReferencedDocumentsAlwaysLoaded, PluginDocument.ReferencedDocumentsNotLoaded, PluginDocument.SizeRequiredToLoadIntoMemoryProvider

Nested classes/interfaces inherited from interface com.biomatters.geneious.publicapi.documents.XMLSerializable

XMLSerializable.OldVersionCompatible, XMLSerializable.VersionSupportType

Field Summary

Fields inherited from interface com.biomatters.geneious.publicapi.documents.PluginDocument

FILE_DATA_ATTRIBUTE_NAME, MAXIMUM_HTML_LENGTH, MODIFIED_DATE_FIELD

Fields inherited from interface com.biomatters.geneious.publicapi.documents.XMLSerializable

ROOT_ELEMENT_NAME

Method Summary

Methods inherited from interface com.biomatters.geneious.publicapi.documents.PluginDocument

getCreationDate, getDescription, getDisplayableFields, getFieldValue, getName, getURN, toHTML

Methods inherited from interface com.biomatters.geneious.publicapi.documents.XMLSerializable

fromXML, toXML