Package com.veeva.vault.sdk.api.core

Interface ErrorResult

public interface ErrorResult
Represents an error.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getMessage()
    Returns a human-readable error message.
    String
    getSubtype()
    Returns machine-readable error subtype An error message of this form can be used to make programmatic decisions. This value is set by Vault Java SDK Code.
    String
    getType()
    Returns a machine-readable error type An error message of this form can be used to make programmatic decisions. If the error is raised by Vault Java SDK Code, for example by calling RecordChange.setError(String, String), type will always be SDK_ERROR. The subtype value specified by Vault Java SDK Code can be retrieved using getSubtype()

  • Method Details

    • getMessage

      String getMessage()
      Returns a human-readable error message.

      An error message of this form should not be used to make programmatic decisions.

      Returns:
      a non-null, human-readable error message

    • getType

      String getType()
      Returns a machine-readable error type
      • An error message of this form can be used to make programmatic decisions.
      • If the error is raised by Vault Java SDK Code, for example by calling RecordChange.setError(String, String), type will always be SDK_ERROR.
      • The subtype value specified by Vault Java SDK Code can be retrieved using getSubtype()
      Returns:
      a non-null error type

    • getSubtype

      String getSubtype()
      Returns machine-readable error subtype
      Returns:
      error subtype, may return null if no subtype exists