Interface FolderViewDocument
-
- All Superinterfaces:
PluginDocument
,XMLSerializable
public interface FolderViewDocument extends PluginDocument
A PluginDocument may implement this interface to indicate that it provides information about the results of a search. For example a query centric view of a blast search. SeeFolderView
for details.
-
-
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
All Methods Instance Methods Abstract Methods Modifier and Type Method Description FolderView
getFolderView()
Get the folder view for this document.-
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
-
-
-
-
Method Detail
-
getFolderView
FolderView getFolderView()
Get the folder view for this document. The implementation is responsible for serializing the folderview to XML as part of its own serialization.- Returns:
- the folder view for this document. Is never null.
-
-