Package com.ellucian.ethos.integration.client.errors

Class EthosError

  • public class EthosError
extends Object
    An Ellucian Ethos Integration Error object.
    Since:
    0.0.1

    • Constructor Detail

      • EthosError

        public EthosError()
        No-arg constructor

    • Method Detail

      • getId

        public String getId()
        Get the ID for this error
        Returns:
        the ID

      • getSeverity

        public String getSeverity()
        Get the Severity for the error. This should be one of info, warning, or error.
        Returns:
        the severity

      • getResponseCode

        public int getResponseCode()
        Get the response code associated with this error.
        Returns:
        the response code

      • getDescription

        public String getDescription()
        Get the description for this error.
        Returns:
        the description

      • getDetails

        public String getDetails()
        Get the detailed message for this error.
        Returns:
        the detailed error message

      • getApplicationId

        public String getApplicationId()
        Get the ID of the application that reported the error.
        Returns:
        the application ID

      • getApplicationName

        public String getApplicationName()
        Get the name of the application that reported the error.
        Returns:
        the application name

      • getDateTime

        public Date getDateTime()
        Get the date and time that the error was reported.
        Returns:
        the Date that the error was reported.

      • getCorrelationId

        public String getCorrelationId()
        Get the correlation ID for this error. This is the ID of the original operation (event or message) to which this error can be traced.
        Returns:
        the correlation ID

      • getApplicationSubtype

        public String getApplicationSubtype()
        Get the sub-type of the application that reported the error. This could be used to describe a sub-system.
        Returns:
        a String value for the application sub-type.

      • getResource

        public Resource getResource()
        Get the resource associated with this error.
        Returns:
        a Resource object

      • getRequest

        public Request getRequest()
        Get original request that caused the error.
        Returns:
        a Request object

      • setId

        public void setId​(String id)
        Sets the ID (GUID)
        Parameters:
        id - The unique GUID value for this EthosError.

      • setSeverity

        public void setSeverity​(String severity)
        Sets the severity for this error. This should be one of info, warning, or error.
        Parameters:
        severity - The severity for this error.

      • setResponseCode

        public void setResponseCode​(int responseCode)
        Sets the response code for this error.
        Parameters:
        responseCode - The response code to set.

      • setDescription

        public void setDescription​(String description)
        Set the description for this error.
        Parameters:
        description - The error description.

      • setDetails

        public void setDetails​(String details)
        Set the detailed message for this error.
        Parameters:
        details - The detailed error message.

      • setApplicationId

        public void setApplicationId​(String applicationId)
        Set the ID of the application that reported the error.
        Parameters:
        applicationId - The application ID.

      • setApplicationName

        public void setApplicationName​(String applicationName)
        Set the name of the application that reported the error.
        Parameters:
        applicationName - the application name.

      • setDateTime

        public void setDateTime​(Date dateTime)
        Set the date and time that the error was reported.
        Parameters:
        dateTime - the date the error was reported.

      • setCorrelationId

        public void setCorrelationId​(String correlationId)
        Set the correlation ID for this error. This is the ID of the original operation (event or message) to which this error can be traced.
        Parameters:
        correlationId - The correlation ID to set.

      • setApplicationSubtype

        public void setApplicationSubtype​(String applicationSubtype)
        Set the sub-type of the application that reported the error. This could be used to describe a sub-system.
        Parameters:
        applicationSubtype - The application sub-type.

      • setResource

        public void setResource​(Resource resource)
        Get the resource associated with this error.
        Parameters:
        resource - The resource for this error.

      • setRequest

        public void setRequest​(Request request)
        Set original request that caused the error.
        Parameters:
        request - The request causing this error.