Class OpenProgramTask

    • Constructor Detail

      • OpenProgramTask

        public OpenProgramTask​(DomainFile domainFile,
                               int version,
                               boolean forceReadOnly,
                               java.lang.Object consumer)
      • OpenProgramTask

        public OpenProgramTask​(DomainFile domainFile,
                               int version,
                               java.lang.Object consumer)
      • OpenProgramTask

        public OpenProgramTask​(DomainFile domainFile,
                               boolean forceReadOnly,
                               java.lang.Object consumer)
      • OpenProgramTask

        public OpenProgramTask​(DomainFile domainFile,
                               java.lang.Object consumer)
      • OpenProgramTask

        public OpenProgramTask​(java.util.List<DomainFile> domainFileList,
                               boolean forceReadOnly,
                               java.lang.Object consumer)
      • OpenProgramTask

        public OpenProgramTask​(java.util.List<DomainFile> domainFileList,
                               java.lang.Object consumer)
    • Method Detail

      • setOpenPromptText

        public void setOpenPromptText​(java.lang.String text)
      • addProgramToOpen

        public void addProgramToOpen​(DomainFile domainFile,
                                     int version)
      • addProgramToOpen

        public void addProgramToOpen​(DomainFile domainFile,
                                     int version,
                                     boolean forceReadOnly)
      • setSilent

        public void setSilent()
        Invoking this method prior to task execution will prevent any confirmation interaction with the user (e.g., optional checkout, snapshot recovery, etc.). Errors may still be displayed if they occur.
      • setNoCheckout

        public void setNoCheckout()
        Invoking this method prior to task execution will prevent the use of optional checkout which require prompting the user.
      • getOpenPrograms

        public java.util.List<Program> getOpenPrograms()
      • getOpenProgram

        public Program getOpenProgram()
      • run

        public void run​(TaskMonitor monitor)
        Description copied from class: Task
        This is the method that will be called to do the work

        Note: The run(TaskMonitor) method should not make any calls directly on Swing components, as these calls are not thread safe. Place Swing calls in a Runnable, then call Swing.runLater(Runnable) or Swing.runNow(Runnable)to schedule the Runnable inside of the AWT Event Thread.

        Specified by:
        run in class Task
        Parameters:
        monitor - The TaskMonitor that will monitor the executing Task