Interface IPromptQueryImportSpec

public interface IPromptQueryImportSpec
Specification for importing a prompt query. Contains the data needed to decide how the query should be imported.
Since:
8.5.0

  • Method Summary

    Modifier and Type
    Method
    Description
    PromptObjectIdentifier
    getAlternativeConnectionId()
    Gets the optional alternative connection identifier to use instead of the one stored in the prompt query export (if any).
    PromptScope
    getConnectionTargetScope()
    Get the optional scope to import the prompt connection into, if the connection is created alongside the query.
    char[]
    getPassword()
    Gets the password to decrypt the prompt query data.
    @NotNull PromptScope
    getQueryTargetScope()
    Gets the scope to import the prompt query into.
    default boolean
    hasPassword()
    Gets whether a non-empty password is set for decryption.
    boolean
    isUpdateConnectionIfExists()
    Gets whether to update the prompt connection if it already exists in the target scope (identified by its UUID).
    boolean
    isUpdateQueryIfExists()
    Gets whether to update the prompt query if it already exists in the target scope (identified by its UUID).

  • Method Details

    • getAlternativeConnectionId

      PromptObjectIdentifier getAlternativeConnectionId()
      Gets the optional alternative connection identifier to use instead of the one stored in the prompt query export (if any). Needs to be provided when the prompt connection is not part of the import data and therefore cannot be created alongside the query.
      Returns:
      The ID of the alternative connection, if any.

    • getConnectionTargetScope

      PromptScope getConnectionTargetScope()
      Get the optional scope to import the prompt connection into, if the connection is created alongside the query. Needs to be provided if no alternative connection ID is given.
      Returns:
      The scope to import the prompt connection into, if applicable.

    • getPassword

      char[] getPassword()
      Gets the password to decrypt the prompt query data. May be null or empty, in which case no decryption is applied.
      Returns:
      The password to decrypt the prompt query data, or null/empty if no decryption is applied.

    • getQueryTargetScope

      @NotNull @NotNull PromptScope getQueryTargetScope()
      Gets the scope to import the prompt query into.
      Returns:
      The scope of the query.

    • hasPassword

      default boolean hasPassword()
      Gets whether a non-empty password is set for decryption.
      Returns:
      true if a non-empty password was set, false otherwise.

    • isUpdateConnectionIfExists

      boolean isUpdateConnectionIfExists()
      Gets whether to update the prompt connection if it already exists in the target scope (identified by its UUID). Only applies when an alternative connection ID is not provided and the connection is created alongside the query. If false and the prompt connection already exists, an error is raised.
      Returns:
      true if the prompt connection should be updated if it already exists, false otherwise.

    • isUpdateQueryIfExists

      boolean isUpdateQueryIfExists()
      Gets whether to update the prompt query if it already exists in the target scope (identified by its UUID). If false and the prompt query already exists, an error is raised.
      Returns:
      true if the prompt query should be updated if it already exists, false otherwise.