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