org.jmusixmatch.config.StatusCode Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jMusixMatch Show documentation
Java MusixMatch API by Sachin Handiekar
There is a newer version: 1.1.4
package org.jmusixmatch.config;

/**
 * A class to hold the status codes.
 *
 * @author Sachin Handiekar
 * @version 1.0
 */
public class StatusCode {

    /**
     * Status Code - 200
     * 
     * The request was successful
     */
    public static final StatusCode REQ_SUCCESS =
            new StatusCode(200, "The request was successful.");

    /**
     * Status Code - 403
     * 

     * You are not authorized to perform this operation / the api version you�re
     * trying to use has been shut down.
     */
    public static final StatusCode NOT_AUTHORIZED =
            new StatusCode(
                    403,
                    "You are not authorized to perform this operation / the api version you�re trying to use has been shut down.");

    /**
     * Status Code - 402
     * 

     * a limit was reached, either you exceeded per hour requests limits or your
     * balance is insufficient.
     */
    public static final StatusCode LIMIT_REACHED =
            new StatusCode(
                    402,
                    "a limit was reached, either you exceeded per hour requests limits or your balance is insufficient.");

    /**
     * Status Code - 400
     * 

     * The request had bad syntax or was inherently impossible to be satisfied
     */
    public static final StatusCode BAD_SYNTAX =
            new StatusCode(
                    400,
                    "The request had bad syntax or was inherently impossible to be satisfied");

    /**
     * Status Code - 401
     * 

     * The request had bad syntax or was inherently impossible to be satisfied
     */
    public static final StatusCode AUTH_FAILED =
            new StatusCode(
                    401,
                    "The request had bad syntax or was inherently impossible to be satisfied");

    /**
     * Status Code - 404
     * 

     * requested resource was not found
     */
    public static final StatusCode RESOURCE_NOT_FOUND =
            new StatusCode(404, "requested resource was not found");

    /**
     * Status Code - 405
     * 
     * requested method was not found
     */
    public static final StatusCode METHOD_NOT_FOUND =
            new StatusCode(404, "requested method was not found");

    /**
     * An error which has not been defined in the API
     */
    public static final StatusCode ERROR =
            new StatusCode(
                    999,
                    "An error has occured while performing the query. Please contact the administrator.");
    private int statusCode;
    private String statusMessage;

    private StatusCode(int statusCode, String statusMessage) {
        this.statusCode = statusCode;
        this.statusMessage = statusMessage;
    }

    /**
     * @return the statusCode
     */
    public int getStatusCode() {
        return statusCode;
    }

    /**
     * @return the statusMessage
     */
    public String getStatusMessage() {
        return statusMessage;
    }
}