Class InvalidInputParameterException

  • All Implemented Interfaces:
    java.io.Serializable

    public class InvalidInputParameterException
    extends ScenarioServiceException
    InvalidInputParameterException is a specialized exception class that is used by classes of the Scenario Service to indicate that an invalid input parameter has been provided to create or edit a ScenarioInstance.
    See Also:
    Serialized Form
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void addValidationFailureMessage​(java.lang.String paramName, java.lang.String localizedError)
      Add a localized validation failure message for a named input parameter.
      boolean containsValidationFailureMessages()
      Determine if this exception contains any validation failure messages for individual input parameters.
      java.util.Map<java.lang.String,​java.lang.String> getValidationFailureMessages()
      Get an unmodifiable view of the internal map of validation failure messages.
      • 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
    • Constructor Detail

      • InvalidInputParameterException

        public InvalidInputParameterException()
      • InvalidInputParameterException

        public InvalidInputParameterException​(java.lang.String message)
      • InvalidInputParameterException

        public InvalidInputParameterException​(java.lang.String message,
                                              java.lang.Throwable cause)
      • InvalidInputParameterException

        public InvalidInputParameterException​(java.lang.Throwable cause)
    • Method Detail

      • addValidationFailureMessage

        public void addValidationFailureMessage​(java.lang.String paramName,
                                                java.lang.String localizedError)
        Add a localized validation failure message for a named input parameter.
        Parameters:
        paramName - the name of the input parameter.
        localizedError - The localized validation failure message.
      • containsValidationFailureMessages

        public boolean containsValidationFailureMessages()
        Determine if this exception contains any validation failure messages for individual input parameters.
        Returns:
        True if there are messages available.
      • getValidationFailureMessages

        public java.util.Map<java.lang.String,​java.lang.String> getValidationFailureMessages()
        Get an unmodifiable view of the internal map of validation failure messages. Keys are input parameter names. Values are localized validation failure messages.