com.dell.cpsd.service.common.client.callback.ServiceError Maven / Gradle / Ivy

Go to download
/**
 * Copyright © 2017 Dell Inc. or its subsidiaries. All Rights Reserved. 
 * Dell EMC Confidential/Proprietary Information
 */

package com.dell.cpsd.service.common.client.callback;

/**
 * This class contains the error code and message information from a service error.
 *
 * 
 * Copyright © 2017 Dell Inc. or its subsidiaries. All Rights Reserved. 
 * Dell EMC Confidential/Proprietary Information
 * 
 * 
 * @version 1.0
 * 
 * @since 1.0
 */
public class ServiceError
{
    /*
     * The request identifier.
     */
    private String requestId    = null;

    /*
     * The error code.
     */
    private String errorCode    = null;

    /*
     * The error message
     */
    private String errorMessage = null;

    /**
     * ServiceError constructor
     * 
     * @param requestId
     *            The request identifier.
     * @param errorCode
     *            The error code.
     * @param errorMessage
     *            The error message.
     * 
     * @since 1.0
     */
    public ServiceError(String requestId, String errorCode, String errorMessage)
    {
        super();

        if (requestId == null)
        {
            throw new IllegalArgumentException("The request identifier is not set.");
        }

        this.requestId = requestId;

        this.errorCode = errorCode;

        this.errorMessage = errorMessage;
    }

    /**
     * This returns the request identifier.
     * 
     * @return The request identifier.
     * 
     * @since 1.0
     */
    public String getRequestId()
    {
        return this.requestId;
    }

    /**
     * This returns the error code.
     * 
     * @return The error code.
     * 
     * @since 1.0
     */
    public String getErrorCode()
    {
        return this.errorCode;
    }

    /**
     * This returns the error message
     * 
     * @return The error message.
     * 
     * @since 1.0
     */
    public String getErrorMessage()
    {
        return this.errorMessage;
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public String toString()
    {
        StringBuilder builder = new StringBuilder();

        builder.append("ServiceError{requestId=");
        builder.append(this.requestId);
        builder.append(", errorCode=");
        builder.append(this.errorCode);
        builder.append(", errorMessage=");
        builder.append(this.errorMessage);
        builder.append("}");

        return builder.toString();
    }
}