Package com.orchestranetworks.instance

# Class ValueAccessException

java.lang.Object
java.lang.Throwable
java.lang.Exception
java.lang.RuntimeException
com.orchestranetworks.instance.ValueAccessException

All Implemented Interfaces:
  `Serializable`

public final class ValueAccessException extends RuntimeException
Thrown to indicate when an access to a value is not possible because of some inconsistencies in the data.

When this exception is thrown in the context of the user interface display or data validation, no stack trace is logged: it is not considered as an "unexpected error" and/or requiring any specific debugging. More precisely for data validation, if this exception is thrown then the specified user message is added to the validation report and the validation process is not stopped.

- ## Method Summary

  Modifier and Type
  Method
  Description
  `static ValueAccessException`
  `createError(UserMessage aMessage)`
  Creates an exception associated with the specified user message.
  `UserMessage`
  `getUserMessage()`
  Returns the user message associated with this exception.

  ### Methods inherited from class java.lang.Throwable

  `addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString`

  ### Methods inherited from class java.lang.Object

  `equals, getClass, hashCode, notify, notifyAll, wait, wait, wait`

- ## Method Details

  - ### createError

    public static ValueAccessException createError(UserMessage aMessage)
    Creates an exception associated with the specified user message.
    Throws:
      `IllegalArgumentException` - if the specified message is `null`.
      `IllegalArgumentException` - if the specified message is not of error severity.

  - ### getUserMessage

    public UserMessage getUserMessage()
    Returns the user message associated with this exception.