com.ansys.ingress.client.api

## Class AdministrationException

- java.lang.Object
- - java.lang.Throwable
  - - java.lang.Exception
    - - com.ansys.ingress.commons.IngressException
      - - com.ansys.ingress.client.api.EkmException
        - - com.ansys.ingress.client.api.AdministrationException

- All Implemented Interfaces:
    com.ansys.ingress.commons.IngressExceptionDetails, java.io.Serializable

      public class AdministrationException
      extends EkmException

  AdministrationException is the exception thrown when operations defined in the `AdministrationManager` interface fail.
  See Also:
    Serialized Form

- - ### Nested Class Summary

    Nested Classes
    Modifier and Type | Class and Description
    --- | ---
    `static class` | `AdministrationException.Reason` Reason defines the message keys for an `AdministrationException`.

  - ### Field Summary

    - ### Fields inherited from class com.ansys.ingress.commons.IngressException

      `DISABLE_USER_FAILED, ENABLE_USER_FAILED`

    - ### Fields inherited from interface com.ansys.ingress.commons.IngressExceptionDetails

      `RESOURCE_NAME`

  - ### Constructor Summary

    Constructors
    Constructor and Description
    `AdministrationException(AdministrationException.Reason reason, java.lang.Exception rootCause, java.lang.Object... params)` Creates a new instance of AdministrationException.
    `AdministrationException(java.lang.Exception e)` Creates a new instance of AdministrationException.

  - ### Method Summary

    - ### Methods inherited from class com.ansys.ingress.client.api.EkmException

      `getBundlePackage, getMessage, getServerErrorDetails, getServerErrorMessage, getServerException, getServerRootCause, getServerRootCauseMessage, getServerStackTrace, getStatusCode, setServerErrorMessage, setServerException, setServerRootCause, setServerRootCauseMessage, setServerStackTrace, setStatusCode, toString`

    - ### Methods inherited from class com.ansys.ingress.commons.IngressException

      `getBundleBasename, getDetailKey, getKey, getLocalizedMessage, getLocalizedMessage, getParams, messageFromKey, setKey, setParams`

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

      `addSuppressed, fillInStackTrace, getCause, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace`

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

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

    - ### Methods inherited from interface com.ansys.ingress.commons.IngressExceptionDetails

      `getCause`

- - ### Constructor Detail

    - #### AdministrationException

          public AdministrationException(java.lang.Exception e)

      Creates a new instance of AdministrationException.
      Parameters:
        `e` - the root cause of the exception;

    - #### AdministrationException

          public AdministrationException(AdministrationException.Reason reason,
                                         java.lang.Exception rootCause,
                                         java.lang.Object... params)

      Creates a new instance of AdministrationException.
      Parameters:
        `reason` - a message key
        `rootCause` - the root cause of the exception
        `params` - Optional parameters for the error message