View Javadoc
1   /*
2    * This file is part of Waarp Project (named also Waarp or GG).
3    *
4    *  Copyright (c) 2019, Waarp SAS, and individual contributors by the @author
5    *  tags. See the COPYRIGHT.txt in the distribution for a full listing of
6    * individual contributors.
7    *
8    *  All Waarp Project is free software: you can redistribute it and/or
9    * modify it under the terms of the GNU General Public License as published by
10   * the Free Software Foundation, either version 3 of the License, or (at your
11   * option) any later version.
12   *
13   * Waarp is distributed in the hope that it will be useful, but WITHOUT ANY
14   * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
15   * A PARTICULAR PURPOSE. See the GNU General Public License for more details.
16   *
17   *  You should have received a copy of the GNU General Public License along with
18   * Waarp . If not, see <http://www.gnu.org/licenses/>.
19   */
20  package org.waarp.openr66.context.task;
21  
22  import org.waarp.openr66.context.R66Session;
23  
24  /**
25   * Runnable interface for internal R66 tasks (through Rule EXECJAVA, or through
26   * message BusinessRequestPacket)
27   */
28  public interface R66Runnable extends Runnable {
29  
30    /**
31     * The way the parameter will be set
32     *
33     * @param session The current R66Session
34     * @param waitForValidation True if the caller will wait up to delay
35     *     time
36     *     in ms
37     * @param useLocalExec True if currently R66 is configured to use
38     *     LocalExec (may be ignored)
39     * @param delay Delay in ms used only if waitForValidation is True
40     * @param classname The Classname
41     * @param arg full argument
42     * @param callFromBusiness True if called from Business operation,
43     *     not
44     *     task
45     * @param isToValidate True if the call from Business is to Validate
46     */
47    void setArgs(R66Session session, boolean waitForValidation,
48                 boolean useLocalExec, int delay, String classname, String arg,
49                 boolean callFromBusiness, boolean isToValidate);
50  
51    /**
52     * @return the final status where 0 is OK, 1 is Warning, 2 is Error
53     */
54    int getFinalStatus();
55  
56    /**
57     * @return Information on task
58     */
59    @Override
60    String toString();
61  }