/*
 * java-gnome, a UI library for writing GTK and GNOME programs from Java!
 *
 * Copyright © 2009-2010 Operational Dynamics Consulting, Pty Ltd
 *
 * The code in this file, and the program it is a part of, is made available
 * to you by its authors as open source software: you can redistribute it
 * and/or modify it under the terms of the GNU General Public License version
 * 2 ("GPL") as published by the Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE. See the GPL for more details.
 *
 * You should have received a copy of the GPL along with this program. If not,
 * see http://www.gnu.org/licenses/. The authors of this program may be
 * contacted through http://java-gnome.sourceforge.net/.
 *
 * Linking this library statically or dynamically with other modules is making
 * a combined work based on this library. Thus, the terms and conditions of
 * the GPL cover the whole combination. As a special exception (the
 * "Claspath Exception"), the copyright holders of this library give you
 * permission to link this library with independent modules to produce an
 * executable, regardless of the license terms of these independent modules,
 * and to copy and distribute the resulting executable under terms of your
 * choice, provided that you also meet, for each linked independent module,
 * the terms and conditions of the license of that module. An independent
 * module is a module which is not derived from or based on this library. If
 * you modify this library, you may extend the Classpath Exception to your
 * version of the library, but you are not obligated to do so. If you do not
 * wish to do so, delete this exception statement from your version.
 */
package org.gnome.unique;

import org.freedesktop.bindings.Constant;

/**
 * Constants enumerating the reponse that a Application.MessageReceived
 * handler can make.
 * 
 * <p>
 * The descriptions below correspond to the interpretation that the program
 * calling {@link Application#sendMessage(Command, MessageData) sendMessage()}
 * should apply to the returned Response.
 * 
 * @author Andrew Cowie
 * @since 4.0.12
 */
public class Response extends Constant
{
    private Response(int ordinal, String nickname) {
        super(ordinal, nickname);
    }

    /**
     * The command was completed successfully.
     */
    public static final Response OK = new Response(UniqueResponse.OK, "OK");

    /**
     * For whatever reason, the command was not handled by the instance.
     */
    public static final Response PASSTHROUGH = new Response(UniqueResponse.PASSTHROUGH, "PASSTHROUGH");

    /**
     * There was some kind of inter-process commuincation failure. The command
     * was not handled.
     */
    public static final Response FAIL = new Response(UniqueResponse.FAIL, "FAIL");

    /**
     * The command was cancelled by the user at the other side.
     */
    public static final Response CANCEL = new Response(UniqueResponse.CANCEL, "CANCEL");
}