Class OMRSAPIResponse

    • Field Detail

      • relatedHTTPCode

        protected int relatedHTTPCode
      • actionDescription

        protected java.lang.String actionDescription
      • exceptionClassName

        protected java.lang.String exceptionClassName
      • exceptionCausedBy

        protected java.lang.String exceptionCausedBy
      • exceptionErrorMessage

        protected java.lang.String exceptionErrorMessage
      • exceptionErrorMessageId

        protected java.lang.String exceptionErrorMessageId
      • exceptionErrorMessageParameters

        protected java.lang.String[] exceptionErrorMessageParameters
      • exceptionSystemAction

        protected java.lang.String exceptionSystemAction
      • exceptionUserAction

        protected java.lang.String exceptionUserAction
      • exceptionProperties

        protected java.util.Map<java.lang.String,​java.lang.Object> exceptionProperties
    • Constructor Detail

      • OMRSAPIResponse

        public OMRSAPIResponse()
        Default constructor
      • OMRSAPIResponse

        public OMRSAPIResponse​(OMRSAPIResponse template)
        Copy/clone constructor
        Parameters:
        template - object to copy
    • Method Detail

      • getExceptionClassName

        public java.lang.String getExceptionClassName()
        Return the name of the Java class name to use to recreate the exception.
        Returns:
        String name of the fully-qualified java class name
      • setExceptionClassName

        public void setExceptionClassName​(java.lang.String exceptionClassName)
        Set up the name of the Java class name to use to recreate the exception.
        Parameters:
        exceptionClassName - - String name of the fully-qualified java class name
      • getExceptionCausedBy

        public java.lang.String getExceptionCausedBy()
        Return the name of any nested exception that may indicate the root cause of the exception.
        Returns:
        exception class name
      • setExceptionCausedBy

        public void setExceptionCausedBy​(java.lang.String exceptionCausedBy)
        Set up the name of any nested exception that may indicate the root cause of the exception.
        Parameters:
        exceptionCausedBy - exception class name
      • getActionDescription

        public java.lang.String getActionDescription()
        Return the description of the activity in progress when the exception occurred.
        Returns:
        string description
      • setActionDescription

        public void setActionDescription​(java.lang.String actionDescription)
        Set up the description of the activity in progress when the exception occurred.
        Parameters:
        actionDescription - string description
      • getRelatedHTTPCode

        public int getRelatedHTTPCode()
        Return the HTTP Code to use if forwarding response to HTTP client.
        Returns:
        integer HTTP status code
      • setRelatedHTTPCode

        public void setRelatedHTTPCode​(int relatedHTTPCode)
        Set up the HTTP Code to use if forwarding response to HTTP client.
        Parameters:
        relatedHTTPCode - - integer HTTP status code
      • getExceptionErrorMessage

        public java.lang.String getExceptionErrorMessage()
        Return the error message associated with the exception.
        Returns:
        string error message
      • setExceptionErrorMessage

        public void setExceptionErrorMessage​(java.lang.String exceptionErrorMessage)
        Set up the error message associated with the exception.
        Parameters:
        exceptionErrorMessage - - string error message
      • getExceptionErrorMessageId

        public java.lang.String getExceptionErrorMessageId()
        Return the formal message identifier for the error message. This is incorporated in the error message. This is provided both for automated processing and to enable the error message to be reformatted in a different language.
        Returns:
        string identifier
      • setExceptionErrorMessageId

        public void setExceptionErrorMessageId​(java.lang.String exceptionErrorMessageId)
        Set up the formal message identifier for the error message. This is incorporated in the error message. This is provided both for automated processing and to enable the error message to be reformatted in a different language.
        Parameters:
        exceptionErrorMessageId - string identifier
      • getExceptionErrorMessageParameters

        public java.lang.String[] getExceptionErrorMessageParameters()
        Return the parameters that were inserted in the error message. These are provided both for automated processing and to enable the error message to be reformatted in a different language.
        Returns:
        list of strings
      • setExceptionErrorMessageParameters

        public void setExceptionErrorMessageParameters​(java.lang.String[] exceptionErrorMessageParameters)
        Set up the list of parameters inserted in to the error message. These are provided both for automated processing and to enable the error message to be reformatted in a different language.
        Parameters:
        exceptionErrorMessageParameters - list of strings
      • getExceptionSystemAction

        public java.lang.String getExceptionSystemAction()
        Return the description of the action taken by the system as a result of the exception.
        Returns:
        - string description of the action taken
      • setExceptionSystemAction

        public void setExceptionSystemAction​(java.lang.String exceptionSystemAction)
        Set up the description of the action taken by the system as a result of the exception.
        Parameters:
        exceptionSystemAction - - string description of the action taken
      • getExceptionUserAction

        public java.lang.String getExceptionUserAction()
        Return the action that a user should take to resolve the problem.
        Returns:
        string instructions
      • setExceptionUserAction

        public void setExceptionUserAction​(java.lang.String exceptionUserAction)
        Set up the action that a user should take to resolve the problem.
        Parameters:
        exceptionUserAction - - string instructions
      • getExceptionProperties

        public java.util.Map<java.lang.String,​java.lang.Object> getExceptionProperties()
        Return the additional properties stored by the exceptions.
        Returns:
        property map
      • setExceptionProperties

        public void setExceptionProperties​(java.util.Map<java.lang.String,​java.lang.Object> exceptionProperties)
        Set up the additional properties stored by the exceptions.
        Parameters:
        exceptionProperties - property map
      • toString

        public java.lang.String toString()
        Standard toString method.
        Overrides:
        toString in class java.lang.Object
        Returns:
        print out of variables in a JSON-style
      • equals

        public boolean equals​(java.lang.Object objectToCompare)
        Compare the values of the supplied object with those stored in the current object.
        Overrides:
        equals in class java.lang.Object
        Parameters:
        objectToCompare - supplied object
        Returns:
        boolean result of comparison
      • hashCode

        public int hashCode()
        Create a hash code for this element type.
        Overrides:
        hashCode in class java.lang.Object
        Returns:
        int hash code