Module org.cruk.clarity.api
Package com.genologics.ri.exception

Class Exception

java.lang.Object
com.genologics.ri.exception.Exception
All Implemented Interfaces:
Serializable
public class Exception extends Object implements Serializable
Exception is a descriptive error message that is returned instead of the standard response for any request that the system was unable to process.

Exception will include a code corresponding to the HTTP response code of the error. Typical response codes are 400, indicating that the submitted request was not valid and cannot be reattempted without corrective action being taken, or 500 indicating that there was an internal error in the server when attempting to process the request. Refer to the section on HTTP response codes in the API reference documentation for further details about the categories and meanings of HTTP response codes.

Exception will include a message element with a textual summary of the error, and may also provide a suggested-actions element with details on how to correct the problem.

Note that within the client, these exceptions are converted to true Java ClarityException automatically.

See Also:

  • Field Details

    • message

      protected String message

    • suggestedActions

      protected String suggestedActions

    • category

      protected String category

    • code

      protected String code

  • Constructor Details

    • Exception

      public Exception()

  • Method Details

    • getMessage

      public String getMessage()

    • setMessage

      public void setMessage(String message)

    • getSuggestedActions

      public String getSuggestedActions()

    • setSuggestedActions

      public void setSuggestedActions(String suggestedActions)

    • getCategory

      public String getCategory()

    • setCategory

      public void setCategory(String category)

    • getCode

      public String getCode()

    • setCode

      public void setCode(String code)