/*

 * Copyright (c) 1997, 2012, Oracle and/or its affiliates. All rights reserved.

 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.

 *

 * This code is free software; you can redistribute it and/or modify it

 * under the terms of the GNU General Public License version 2 only, as

 * published by the Free Software Foundation.  Oracle designates this

 * particular file as subject to the "Classpath" exception as provided

 * by Oracle in the LICENSE file that accompanied this code.

 *

 * This code 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 GNU General Public License

 * version 2 for more details (a copy is included in the LICENSE file that

 * accompanied this code).

 *

 * You should have received a copy of the GNU General Public License version

 * 2 along with this work; if not, write to the Free Software Foundation,

 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.

 *

 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA

 * or visit www.oracle.com if you need additional information or have any

 * questions.

 */

package javax.activation;

import java.io.IOException;

/**

 * JavaBeans components that are Activation Framework aware implement

 * this interface to find out which command verb they're being asked

 * to perform, and to obtain the DataHandler representing the

 * data they should operate on.  JavaBeans that don't implement

 * this interface may be used as well.  Such commands may obtain

 * the data using the Externalizable interface, or using an

 * application-specific method.

 *

 * @since 1.6

 */

public interface CommandObject {

    /**

     * Initialize the Command with the verb it is requested to handle

     * and the DataHandler that describes the data it will

     * operate on. <b>NOTE:</b> it is acceptable for the caller

     * to pass <i>null</i> as the value for {@code DataHandler}.

     *

     * @param verb The Command Verb this object refers to.

     * @param dh The DataHandler.

     */

    public void setCommandContext(String verb, DataHandler dh)

                                                throws IOException;

}