Package com.biomatters.geneious.publicapi.documents

Interface AnnotatedPluginDocument.DocumentNotes

  • Enclosing class:
    AnnotatedPluginDocument
    public static interface AnnotatedPluginDocument.DocumentNotes
    Provides access to all the DocumentNotes on an AnnotatedPluginDocument

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.util.List<DocumentNote> getAllNotes()  
      DocumentNote getNote​(java.lang.String code)  
      void removeNote​(java.lang.String code)
      Remove a note from this AnnotatedPluginDocument
      void saveNotes()
      Saves these notes to the AnnotatedPluginDocument and in turn to the database.
      void saveNotes​(boolean updateModifiedDate)
      Saves these notes to the AnnotatedPluginDocument and in turn to the database.
      void saveNotes​(boolean updateModifiedDate, boolean saveToDatabase)
      Saves these notes to the AnnotatedPluginDocument and optionally in turn to the database.
      void setNote​(DocumentNote note)
      Add a note to this document (if no note with the same code exists) or update a note (if a note with the same code does exist).

    • Method Detail

      • getNote

        DocumentNote getNote​(java.lang.String code)
        Parameters:
        code - of DocumentNote to get
        Returns:
        DocumentNote with code code or null if doesn't exist

      • setNote

        void setNote​(DocumentNote note)
        Add a note to this document (if no note with the same code exists) or update a note (if a note with the same code does exist).

        To add a new note use DocumentNoteType.createDocumentNote() to get an instance of the desired note type. Use DocumentNoteUtilities to get access to the available note types.
        Parameters:
        note - to add or modify

      • removeNote

        void removeNote​(java.lang.String code)
        Remove a note from this AnnotatedPluginDocument
        Parameters:
        code - of the note to remove

      • getAllNotes

        java.util.List<DocumentNote> getAllNotes()
        Returns:
        a list of all notes on this AnnotatedPluginDocument

      • saveNotes

        void saveNotes()
        Saves these notes to the AnnotatedPluginDocument and in turn to the database. It is not necessary to call AnnotatedPluginDocument.save() if only notes have been modified, as this method will call it internally. The document's modified date will be updated.

      • saveNotes

        void saveNotes​(boolean updateModifiedDate)
        Saves these notes to the AnnotatedPluginDocument and in turn to the database. It is not necessary to call AnnotatedPluginDocument.save() if only notes have been modified as this method will call it internally.
        Parameters:
        updateModifiedDate - true if, when saving the document these notes belong to, the modified date of the document should be updated. False if not.
        Since:
        API 4.1000 (Geneious 10.0.0)

      • saveNotes

        void saveNotes​(boolean updateModifiedDate,
               boolean saveToDatabase)
        Saves these notes to the AnnotatedPluginDocument and optionally in turn to the database.
        Parameters:
        updateModifiedDate - true if, when saving the document these notes belong to, the modified date of the document should be updated. False if not.
        saveToDatabase - true if, when updating these notes, also save to the database. If this is false, then either AnnotatedPluginDocument.saveDocument() or AnnotatedPluginDocument.save() must be called soon.
        Since:
        API 4.1010 (Geneious 10.1.0)