KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > pentaho > core > services > IActionRequestHandler


1 /*
2  * Copyright 2006 Pentaho Corporation. All rights reserved.
3  * This software was developed by Pentaho Corporation and is provided under the terms
4  * of the Mozilla Public License, Version 1.1, or any later version. You may not use
5  * this file except in compliance with the license. If you need a copy of the license,
6  * please go to http://www.mozilla.org/MPL/MPL-1.1.txt. The Original Code is the Pentaho
7  * BI Platform. The Initial Developer is Pentaho Corporation.
8  *
9  * Software distributed under the Mozilla Public License is distributed on an "AS IS"
10  * basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. Please refer to
11  * the license for the specific language governing your rights and limitations.
12  *
13  * @created Jun 17, 2005
14  * @author James Dixon
15  *
16  */
17
18 package org.pentaho.core.services;
19
20 import org.pentaho.core.runtime.IRuntimeContext;
21
22 import java.util.List JavaDoc;
23
24 /**
25  * The basic interface for requests to execute actions .
26  * @author mbatchel
27  *
28  */
29
30 public interface IActionRequestHandler {
31
32     /**
33      * Responsible for executing the action using the solution engine.
34      * @param timeout Timeout for the execution - currently ignored in the Base
35      * @param timeoutType - currently ignored in the Base
36      * @return RuntimeContext from the execution
37      * @see BaseRequestHandler
38      */
39     public IRuntimeContext handleActionRequest(int timeout, int timeoutType);
40     /**
41      * Executes an action sequence asynchronously.
42      * Note - this is currently not implemented in the BaseRequestHandler
43      * @return RuntimeContext created for the asynchronous execution.
44      */
45     public IRuntimeContext handleActionAsyncRequest();
46
47     /**
48      * Gets the runtime. Currently not called anywhere in the platform
49      * @param requestHandle
50      * @return the RuntimeContext for the execution
51      */
52     public IRuntimeContext getRuntime(String JavaDoc requestHandle);
53
54     /**
55      * As the execution happens, the action handler is responsible for storing
56      * a list of all the messages that occur in the case of component failure.
57      * This method returns that list. The items in the list are presented to the
58      * user as execution feedback.
59      * @return list of messages
60      */
61     public List JavaDoc getMessages();
62     
63     /**
64      * Sets whether to force the generation of a prompt page
65      * @param forcePrompt
66      */
67     public void setForcePrompt( boolean forcePrompt );
68 }
69
Popular Tags