Class ErrorCodeInfo

  • All Implemented Interfaces:
    java.io.Serializable

    public class ErrorCodeInfo
    extends java.lang.Object
    implements java.io.Serializable
    Class representing the full information of error

    It contains information about partner, module, error and solutions collected by ErrorCodeManager plugin methods.

    See Also:
    Serialized Form
    • Constructor Summary

      Constructors 
      Constructor Description
      ErrorCodeInfo()
      Instantiates a new Error code info.
      ErrorCodeInfo​(int partnerIdentifier, java.lang.String partnerName, java.lang.String contactPerson, java.lang.String contactPersonEmail, int moduleNo, java.lang.String moduleName, java.lang.String moduleDescription, java.lang.String moduleConfigFile, int errorNo, java.lang.String errorMessage, java.lang.String errorLanguage, java.util.List<java.lang.String> solution)
      Instantiates a new Error code info.
    • Constructor Detail

      • ErrorCodeInfo

        public ErrorCodeInfo()
        Instantiates a new Error code info.
      • ErrorCodeInfo

        public ErrorCodeInfo​(int partnerIdentifier,
                             java.lang.String partnerName,
                             java.lang.String contactPerson,
                             java.lang.String contactPersonEmail,
                             int moduleNo,
                             java.lang.String moduleName,
                             java.lang.String moduleDescription,
                             java.lang.String moduleConfigFile,
                             int errorNo,
                             java.lang.String errorMessage,
                             java.lang.String errorLanguage,
                             java.util.List<java.lang.String> solution)
        Instantiates a new Error code info.
        Parameters:
        partnerIdentifier - the partner identifier
        partnerName - the partner name
        contactPerson - the contact person
        contactPersonEmail - the contact person email
        moduleNo - the module no
        moduleName - the module name
        moduleDescription - the module description
        moduleConfigFile - the module config file
        errorNo - the error no
        errorMessage - the error message
        errorLanguage - the error language
        solution - the solution
    • Method Detail

      • getPartnerIdentifier

        public int getPartnerIdentifier()
        Get the identifier of the partner.
        Returns:
        identifier int
      • setPartnerIdentifier

        public void setPartnerIdentifier​(int partnerIdentifier)
        Set the identifier of the partner.
        Parameters:
        identifier -
      • getPartnerName

        public java.lang.String getPartnerName()
        Get the name of the partner.
        Returns:
        partnerName String
      • setPartnerName

        public void setPartnerName​(java.lang.String partnerName)
        Set the name of the partner.

        Parameters:
        partnerName -
      • getModuleConfigFile

        public java.lang.String getModuleConfigFile()
        Get the filename of the partner's configuration file.
        Returns:
        moduleConfigFile String
      • setModuleConfigFile

        public void setModuleConfigFile​(java.lang.String moduleConfigFile)
        Set the filename of the partner's configuration file.
        Parameters:
        moduleConfigFile -
      • getContactPerson

        public java.lang.String getContactPerson()
        Get the contact person
        Returns:
        contactPerson String
      • setContactPerson

        public void setContactPerson​(java.lang.String contactPerson)
        Set the contact person
        Parameters:
        contactPerson -
      • getContactPersonEmail

        public java.lang.String getContactPersonEmail()
        Get the contact person email
        Returns:
        contactPersonEmail String
      • setContactPersonEmail

        public void setContactPersonEmail​(java.lang.String contactPersonEmail)
        Set the contact person
        Parameters:
        contactPersonEmail -
      • getModuleNo

        public int getModuleNo()
        Get the module number
        Returns:
        moduleNo int
      • setModuleNo

        public void setModuleNo​(int moduleNo)
        Set the module number
        Parameters:
        moduleNo -
      • getModuleName

        public java.lang.String getModuleName()
        Get the module name.
        Returns:
        moduleName String
      • setModuleName

        public void setModuleName​(java.lang.String moduleName)
        Set the module name.
        Parameters:
        moduleName -
      • getModuleDescription

        public java.lang.String getModuleDescription()
        Get the module description.
        Returns:
        moduleDescription String
      • setModuleDescription

        public void setModuleDescription​(java.lang.String moduleDescription)
        Set the module description.
        Parameters:
        moduleDescription -
      • getErrorNo

        public int getErrorNo()
        Get the error number
        Returns:
        errorNo int
      • setErrorNo

        public void setErrorNo​(int errorNo)
        Set the error number
        Parameters:
        errorNo -
      • getErrorMessage

        public java.lang.String getErrorMessage()
        Get the error message
        Returns:
        errorMessage String
      • getErrorMessage

        public java.lang.String getErrorMessage​(java.lang.Object... args)

        Get the error message with embedded variables. The message string contains variable(s) in the form of {0} {1} etc.

        Parameters:
        args - array of objects used as values of parameters
        Returns:
        errorMessage String
      • getErrorMessage

        public java.lang.String getErrorMessage​(java.lang.String... args)
        Gets error message.
        Parameters:
        args - the args
        Returns:
        the error message
      • setErrorMessage

        public void setErrorMessage​(java.lang.String errorMessage)
        Set the error message
        Parameters:
        errorMessage -
      • getErrorLanguage

        public java.lang.String getErrorLanguage()
        Get the error language
        Returns:
        errorLanguage String
      • setErrorLanguage

        public void setErrorLanguage​(java.lang.String errorLanguage)
        Set the error language
        Parameters:
        errorLanguage -
      • getSolution

        public java.util.List<java.lang.String> getSolution()
        Get the list of error solution

        Each element of list contains possible solution of the error

        Returns:
        solution List
      • setSolution

        public void setSolution​(java.util.List<java.lang.String> solution)
        Set the list of error solution
        Parameters:
        solution -
      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object