Enum EFcPromptQueryError

java.lang.Object
java.lang.Enum<EFcPromptQueryError>
de.xima.fc.workflow.error.EFcPromptQueryError
All Implemented Interfaces:
Serializable, Comparable<EFcPromptQueryError>
public enum EFcPromptQueryError extends Enum<EFcPromptQueryError>
Enumeration of the possible error codes for the EWorkflowNodeType.FC_PROMPT_QUERY action.
Since:
8.5.0
Author:
XIMA MEDIA GmbH

  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    DATABASE_ERROR
    When an error occurred during the communication with the database.
    EXECUTION_FAILED
    The query could not be executed due to an unknown error that cannot be classified further.
    FILE_SYSTEM_ERROR
    When a file could not be read from the file system or written to the file system.
    INVALID_CONFIGURATION
    The query could not be executed because its configuration is invalid.
    INVALID_INPUT_PARAMETERS
    The query could not be executed because the parameters provided were invalid, e.g. when the query requires a value for a parameter but none was provided.
    INVALID_OUTPUT_PARAMETERS
    The query could be executed, but the service returned an invalid or unexpected response with data that does not match the expected output parameters, e.g. when a required output parameter is missing in the response.
    NETWORK_ERROR
    When a file from the network could not be accessed.
    NO_SOURCE_FILE_FOUND
    When a referenced file does not exist.
    PROMPT_CONNECTION_NOT_FOUND
    When the prompt connection could not be found, usually because the entity was deleted in the formcycle backend.
    PROMPT_QUERY_NOT_FOUND
    When the prompt query could not be found, usually because the entity was deleted in the formcycle backend.
    PROMPT_SERVICE_NOT_FOUND
    When the prompt query could be found, but the prompt service responsible for handling that type of query was not found.
    RATE_LIMIT_EXCEEDED
    The query could not be executed because the rate limit for the prompt service has been exceeded.
    REQUEST_REFUSED
    The prompt service refused to answer the request, e.g. due to a violation of its usage policy.
    RESPONSE_REFUSED
    The system refused to accept the response, e.g. due to unsafe content such as malware.
    SERVICE_UNAVAILABLE
    The prompt service is currently unavailable (e.g. because of maintenance) or could not be reached (e.g. because of network issues).
    UNAUTHORIZED_PROMPT_REQUEST
    When the request to the prompt service lacks the required authorization to execute the query, e.g. when the API key is missing or invalid.

  • Method Summary

    Modifier and Type
    Method
    Description
    static EFcPromptQueryError
    valueOf(String name)
    Returns the enum constant of this type with the specified name.
    static EFcPromptQueryError[]
    values()
    Returns an array containing the constants of this enum type, in the order they are declared.

    Methods inherited from class Enum

    clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

    Methods inherited from class Object

    getClass, notify, notifyAll, wait, wait, wait

  • Enum Constant Details

    • DATABASE_ERROR

      public static final EFcPromptQueryError DATABASE_ERROR
      When an error occurred during the communication with the database.

    • EXECUTION_FAILED

      public static final EFcPromptQueryError EXECUTION_FAILED
      The query could not be executed due to an unknown error that cannot be classified further.

    • FILE_SYSTEM_ERROR

      public static final EFcPromptQueryError FILE_SYSTEM_ERROR
      When a file could not be read from the file system or written to the file system.

    • INVALID_CONFIGURATION

      public static final EFcPromptQueryError INVALID_CONFIGURATION
      The query could not be executed because its configuration is invalid. Note that INVALID_INPUT_PARAMETERS refers to the external parameters provided to the query, whereas INVALID_CONFIGURATION refers to the internal (backend) configuration of the prompt query or connection.

    • INVALID_INPUT_PARAMETERS

      public static final EFcPromptQueryError INVALID_INPUT_PARAMETERS
      The query could not be executed because the parameters provided were invalid, e.g. when the query requires a value for a parameter but none was provided. Note that INVALID_INPUT_PARAMETERS refers to the external parameters provided to the query, whereas INVALID_CONFIGURATION refers to the internal (backend) configuration of the prompt query or connection.

    • INVALID_OUTPUT_PARAMETERS

      public static final EFcPromptQueryError INVALID_OUTPUT_PARAMETERS
      The query could be executed, but the service returned an invalid or unexpected response with data that does not match the expected output parameters, e.g. when a required output parameter is missing in the response.

    • NETWORK_ERROR

      public static final EFcPromptQueryError NETWORK_ERROR
      When a file from the network could not be accessed.

    • NO_SOURCE_FILE_FOUND

      public static final EFcPromptQueryError NO_SOURCE_FILE_FOUND
      When a referenced file does not exist.

    • PROMPT_QUERY_NOT_FOUND

      public static final EFcPromptQueryError PROMPT_QUERY_NOT_FOUND
      When the prompt query could not be found, usually because the entity was deleted in the formcycle backend.

    • PROMPT_CONNECTION_NOT_FOUND

      public static final EFcPromptQueryError PROMPT_CONNECTION_NOT_FOUND
      When the prompt connection could not be found, usually because the entity was deleted in the formcycle backend.

    • PROMPT_SERVICE_NOT_FOUND

      public static final EFcPromptQueryError PROMPT_SERVICE_NOT_FOUND
      When the prompt query could be found, but the prompt service responsible for handling that type of query was not found. Usually happens when the prompt service was provided by a plugin that is no longer installed.

    • RATE_LIMIT_EXCEEDED

      public static final EFcPromptQueryError RATE_LIMIT_EXCEEDED
      The query could not be executed because the rate limit for the prompt service has been exceeded.

    • REQUEST_REFUSED

      public static final EFcPromptQueryError REQUEST_REFUSED
      The prompt service refused to answer the request, e.g. due to a violation of its usage policy.

    • RESPONSE_REFUSED

      public static final EFcPromptQueryError RESPONSE_REFUSED
      The system refused to accept the response, e.g. due to unsafe content such as malware.

    • SERVICE_UNAVAILABLE

      public static final EFcPromptQueryError SERVICE_UNAVAILABLE
      The prompt service is currently unavailable (e.g. because of maintenance) or could not be reached (e.g. because of network issues).

    • UNAUTHORIZED_PROMPT_REQUEST

      public static final EFcPromptQueryError UNAUTHORIZED_PROMPT_REQUEST
      When the request to the prompt service lacks the required authorization to execute the query, e.g. when the API key is missing or invalid. This implies authentication failures as well.

  • Method Details

    • values

      public static EFcPromptQueryError[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      Returns:
      an array containing the constants of this enum type, in the order they are declared

    • valueOf

      public static EFcPromptQueryError valueOf(String name)
      Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum type has no constant with the specified name
      NullPointerException - if the argument is null