Start line:  
End line:  

Snippet Preview

Snippet HTML Code

Stack Overflow Questions
  /*
   * This program is free software; you can redistribute it and/or modify it under the 
   * terms of the GNU Lesser General Public License, version 2.1 as published by the Free Software 
   * Foundation.
   *
   * You should have received a copy of the GNU Lesser General Public License along with this 
   * program; if not, you can obtain a copy at http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html 
   * or from the Free Software Foundation, Inc., 
   * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  *
  * This program 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 Lesser General Public License for more details.
  *
  * Copyright 2005 - 2008 Pentaho Corporation.  All rights reserved.
  *
  * @created Jun 17, 2005 
  * @author James Dixon
  * 
  */
 
 package org.pentaho.platform.api.engine;
 
 import java.util.List;
 import java.util.Map;

The Solution Engine handles loading and launching execution of solutions and action sequences. There is one solution engine per request, which can launch one or more action sequences.
 
 public interface ISolutionEngine extends ILogger {
 
   public static final String RUNTIME_SOLUTION_NAME = "RuntimeSolution"//$NON-NLS-1$
 
  
Sets the source for input parameters.

Parameters:
name name to give to this provider
parameterProvider instance of a provider
See also:
org.pentaho.platform.api.engine.services.IParameterProvider
 
   public void setParameterProvider(String nameIParameterProvider parameterProvider);
 
Executes the action sequence specified in the manner described in the parameters

Parameters:
actionPath the path to the solution action that will lead to the requested action
processId id for the given action sequence document
async synchronous(false) or asynchronous(true) execution (not currently used)
instanceId id to be handed to the runtime repository
persisted if true, store runtime data, otherwise do not
parameterProviderMap group of ParameterProviders, sources for inout parameters
outputHandler handler used to query for addition parameters
listener object notified on completion of action sequences
urlFactory factory for building urls
messages list into which debug, info, warning, and errors messages will be added
Returns:
IRuntimeContext the RuntimeContext associated with this action sequence execution
See also:
IRuntimeContext
 
   @SuppressWarnings("unchecked")
   public IRuntimeContext execute(String actionPathString processId,
       boolean asyncboolean instanceEndsString instanceIdboolean persistedMap parameterProviderMap,
       IOutputHandler outputHandlerIActionCompleteListener listenerIPentahoUrlFactory urlFactoryList messages);

  
Executes the action sequence specified

Parameters:
runtime The runtime context for the execution
actionPath path to the action
processId id for the given process, typically a GUID or unique id for this execution
async true if the execution should be asynchronous.
instanceEnds currently true indicating that the process ends with this execution
parameterProviderMap Map of parameter providers to use for the execution
outputHandler The output handler for dealing with user feedback
Returns:
The runtime context for the execution
See also:
IRuntimeContext
IParameterProvider
IActionSequence
 
  @SuppressWarnings("unchecked")
  public IRuntimeContext execute(IRuntimeContext runtimeString actionPathString processIdboolean asyncboolean instanceEndsMap parameterProviderMap,
      IOutputHandler outputHandler);

  
Executes the in memory action sequence specified

Parameters:
actionSequenceXML the in memory action sequence string
sequenceName name of the action sequence
processId id for the given process, typically a GUID or unique id for this execution
async true if the execution should be asynchronous.
instanceEnds currently true indicating that the process ends with this execution
parameterProviderMap Map of parameter providers to use for the execution
outputHandler The output handler for dealing with user feedback
Returns:
The runtime context for the execution
See also:
IRuntimeContext
IParameterProvider
IActionSequence
  @SuppressWarnings("unchecked")
  public IRuntimeContext execute(String actionSequenceXMLString sequenceNameString processIdboolean async,
      boolean instanceEndsString instanceIdboolean persistedMap parameterProviderMap,
      IOutputHandler outputHandlerIActionCompleteListener pListenerIPentahoUrlFactory urlFactoryList messages);

  
Sets the action complete listener which will be called when the action is complete

Parameters:
listener Listener to call back when execution is complete.
  public void setlistener(IActionCompleteListener listener);
  public void setlistener(IExecutionListener execListener);

  
Sets the session in the solution engine

Parameters:
session The session for this execution
  public void setSession(IPentahoSession session);

  

Returns:
the runtime context being used for this execution.

Returns:
Gets the current status from this execution
  public int getStatus();

  
Initialize the SolutionEngine. This method should be called immediately after object construction, and if solution engines are re-used among different IPentahoSessions to bind the solution engine to the session.

Parameters:
session the session context for this SolutionEngine
  public void init(IPentahoSession session);

  
Sets if the promp page should be forced

Parameters:
status
  public void setForcePrompt(boolean forcePrompt);

  
Sets the xsl file to be used to generate the parameter page for the current component. The parameter should be a full path from the solution root starting with a /, or it should be a path relative to the directory of the current action sequence.

Parameters:
xsl The name of the XSL file
  public void setParameterXsl(String xsl);
New to GrepCode? Check out our FAQ X