Interface IPromptQueryExportSpec

All Superinterfaces:
Serializable
public interface IPromptQueryExportSpec extends Serializable
Specification for exporting a prompt query, including the prompt query identifier and an optional password for encryption.
Since:
8.5.0

  • Method Summary

    Modifier and Type
    Method
    Description
    char[]
    getPassword()
    Gets the password to encrypt the exported prompt data.
    @NotNull PromptObjectIdentifier
    getPromptQueryId()
    Gets the identifier of the prompt query to export.
    default boolean
    isEncrypted()
    Checks if the export should be encrypted, based on the presence of a password.
    boolean
    isExportConnection()
    Gets whether to export the associated connection as well.

  • Method Details

    • isExportConnection

      boolean isExportConnection()
      Gets whether to export the associated connection as well.

      ATTENTION: Enabling this option may lead to security risks if the connection contains sensitive information. Therefore, ensure that the exported data is encrypted directly or part of an encrypted archive (e.g. encrypted project export) when using this option.

      Returns:
      true to export the connection, false to only export the prompt query.

    • getPassword

      char[] getPassword()
      Gets the password to encrypt the exported prompt data. May be null or empty, in which case no encryption is applied.
      Returns:
      The password as a character array, or null/empty if no encryption is desired.

    • getPromptQueryId

      @NotNull @NotNull PromptObjectIdentifier getPromptQueryId()
      Gets the identifier of the prompt query to export.
      Returns:
      The identifier of the prompt query to export.

    • isEncrypted

      default boolean isEncrypted()
      Checks if the export should be encrypted, based on the presence of a password.
      Returns:
      true if a non-empty password was set, false otherwise.