Scenario.java revision 13978:1993af50385d 
1/*
2 * Copyright (c) 1997, 2016, Oracle and/or its affiliates. All rights reserved.
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * This code is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License version 2 only, as
7 * published by the Free Software Foundation.
8 *
9 * This code is distributed in the hope that it will be useful, but WITHOUT
10 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
11 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
12 * version 2 for more details (a copy is included in the LICENSE file that
13 * accompanied this code).
14 *
15 * You should have received a copy of the GNU General Public License version
16 * 2 along with this work; if not, write to the Free Software Foundation,
17 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
18 *
19 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
20 * or visit www.oracle.com if you need additional information or have any
21 * questions.
22 */
23package org.netbeans.jemmy;
24
25/**
26 *
27 * A test scenario. This interface provides a mechanism for putting something
28 * into execution. The execution is conditioned in a very general way by passing
29 * a {@code java.lang.Object} to it's {@code runIt} method.
30 *
31 * @see Test
32 *
33 * @author Alexandre Iline (alexandre.iline@oracle.com)
34 */
35public interface Scenario {
36
37    /**
38     * Defines a way to execute this test scenario.
39     *
40     * @param param An object passed to configure the test scenario execution.
41     * For example, this parameter might be a      <code>java.lang.String[]<code> object that lists the
42     * command line arguments to the Java application corresponding
43     * to a test.
44     * @return an int that tells something about the execution. For, example, a
45     * status code.
46     */
47    public int runIt(Object param);
48}
49