ResponseStatus.java

/*
 * The MIT License (MIT)
 *
 * Copyright (c) 2015 Jakob Hendeß
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */

package org.xlrnet.metadict.web.api;

/**
 * The {@link ResponseStatus} represents different status codes that can be returned for a request.
 */
public enum ResponseStatus {

    /**
     * The query executed successfully in the Metadict core.
     */
    OK,

    /**
     * The query failed for a reason that was not caused by the Metadict core.
     */
    ERROR,

    /**
     * An internal error occurred in the Metadict core.
     */
    INTERNAL_ERROR,

    /**
     * A malformed query was received. This does not indicate an error in the Metadict core.
     */
    MALFORMED_QUERY,

    /**
     * A resource with the same id already exists.
     */
    DUPLICATE,

    /**
     * User not authorized.
     */
    UNAUTHORIZED

}