Package com.orchestranetworks.addon.dex.configuration

Class ExportDataExchangeConfigurationSpec

  • public final class ExportDataExchangeConfigurationSpec
extends java.lang.Object
    Defines the configuration used to export the {addon.label} configuration to an XML file.
    Since:
    2.4.2

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.io.File getExportedFile()
      Returns the exported file.
      java.util.Set<com.onwbp.adaptation.PrimaryKey> getPreferenceRecords()
      Returns a PrimaryKey collection that identifies records in the Application interface preference table located in the {addon.label} dataset.
      com.orchestranetworks.service.Session getSession()
      Returns the current session.
      boolean isXMLCommentOmitted()
      Returns true if the exported XML file omits comments.
      boolean isXMLIndented()
      Returns true if the exported XML file includes indentations.
      void setExportedFile​(java.io.File exportedFile)
      Sets the exported file.
      void setPreferenceRecords​(java.util.Set<com.onwbp.adaptation.PrimaryKey> preferenceRecords)
      Sets the PrimaryKey collection that identifies records in the Application interface preference table located in the {addon.label} dataset.
      void setSession​(com.orchestranetworks.service.Session session)
      Sets the current session.
      void setXMLCommentOmitted​(boolean xmlCommentOmitted)
      Sets whether to omit XML comments from the exported XML file.
      void setXMLIndented​(boolean xmlIndented)
      Sets whether lines are indented in the exported XML file.

      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • ExportDataExchangeConfigurationSpec

        public ExportDataExchangeConfigurationSpec()

    • Method Detail

      • isXMLIndented

        public boolean isXMLIndented()
        Returns true if the exported XML file includes indentations.

      • setXMLIndented

        public void setXMLIndented​(boolean xmlIndented)
        Sets whether lines are indented in the exported XML file.

      • isXMLCommentOmitted

        public boolean isXMLCommentOmitted()
        Returns true if the exported XML file omits comments.

      • setXMLCommentOmitted

        public void setXMLCommentOmitted​(boolean xmlCommentOmitted)
        Sets whether to omit XML comments from the exported XML file.

      • getSession

        public com.orchestranetworks.service.Session getSession()
        Returns the current session.

      • setSession

        public void setSession​(com.orchestranetworks.service.Session session)
        Sets the current session.

      • getExportedFile

        public java.io.File getExportedFile()
        Returns the exported file.

      • setExportedFile

        public void setExportedFile​(java.io.File exportedFile)
        Sets the exported file.

      • getPreferenceRecords

        public java.util.Set<com.onwbp.adaptation.PrimaryKey> getPreferenceRecords()
        Returns a PrimaryKey collection that identifies records in the Application interface preference table located in the {addon.label} dataset. You can use the collection to export the selected records in the Application interface preference table and the related data from other tables to an XML file.
        Since:
        2.7.0

      • setPreferenceRecords

        public void setPreferenceRecords​(java.util.Set<com.onwbp.adaptation.PrimaryKey> preferenceRecords)
        Sets the PrimaryKey collection that identifies records in the Application interface preference table located in the {addon.label} dataset. You can use the collection to export the selected records in the Application interface preference table and the related data from other tables to an XML file.
        Since:
        2.7.0