org.pentaho.platform.engine.services.solution
Class SolutionHelper

java.lang.Object
  org.pentaho.platform.engine.services.solution.SolutionHelper

public class SolutionHelper
extends Object

Constructor Summary

SolutionHelper()

Method Summary

static IRuntimeContext	doAction(String solutionName, String actionPath, String actionName, String processId, IParameterProvider parameterProvider, IPentahoSession userSession, ArrayList messages, ILogger logger) doAction executes an action within the bi platform and returns the runtime context.
static boolean	doAction(String solutionName, String actionPath, String actionName, String processId, IParameterProvider parameterProvider, OutputStream outputStream, IPentahoSession userSession, ArrayList messages, ILogger logger) doAction executes an action within the bi platform and returns true if successful.
static ISolutionEngine	execute(String description, IPentahoSession session, String actionSequence, Map parameters, OutputStream outputStream) Runs an action sequence.
static ISolutionEngine	execute(String description, IPentahoSession session, String actionSequence, Map parameters, OutputStream outputStream, boolean collateMessages) Runs an action sequence.
static ISolutionEngine	execute(String description, IPentahoSession session, String actionSequence, Map parameters, OutputStream outputStream, IExecutionListener execListener, boolean collateMessages, boolean manageHibernate) Runs an action sequence.
static ISolutionEngine	execute(String description, String userId, String actionSequence, Map parameters, OutputStream outputStream) Runs an action sequence.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SolutionHelper

public SolutionHelper()

Method Detail

execute

public static ISolutionEngine execute(String description,
                                      String userId,
                                      String actionSequence,
                                      Map parameters,
                                      OutputStream outputStream)

Runs an action sequence. This method uses the base URL set by the Application Context

Parameters:

description - An identifier for this process. This is used for auditing and logging purposes only.

userId - The user (or user agent) that is requesting this execution. This is used for auditing and logging and also can be used in action sequences (for example to filter data)

actionSequence - Path to the action sequence file

parameters - Parameters to be passed to the action sequence

outputStream - The output stream for content generated by the action sequence. Can be null.

Returns:

execute

public static ISolutionEngine execute(String description,
                                      IPentahoSession session,
                                      String actionSequence,
                                      Map parameters,
                                      OutputStream outputStream)

Runs an action sequence. This method uses the base URL set by the Application Context

Parameters:

description - An identifier for this process. This is used for auditing and logging purposes only.

session - The user session that is requesting this execution. This is used for auditing and logging and also can be used in action sequences (for example to filter data)

actionSequence - Path to the action sequence file

parameters - Parameters to be passed to the action sequence

outputStream - The output stream for content generated by the action sequence. Can be null.

Returns:

execute

public static ISolutionEngine execute(String description,
                                      IPentahoSession session,
                                      String actionSequence,
                                      Map parameters,
                                      OutputStream outputStream,
                                      boolean collateMessages)

Runs an action sequence. This method uses the base URL set by the Application Context

Parameters:

description - An identifier for this process. This is used for auditing and logging purposes only.

session - The user session that is requesting this execution. This is used for auditing and logging and also can be used in action sequences (for example to filter data)

actionSequence - Path to the action sequence file

parameters - Parameters to be passed to the action sequence

outputStream - The output stream for content generated by the action sequence. Can be null.

collateMessages - Collate a messages list or not. Chose false for very large processes

Returns:

execute

public static ISolutionEngine execute(String description,
                                      IPentahoSession session,
                                      String actionSequence,
                                      Map parameters,
                                      OutputStream outputStream,
                                      IExecutionListener execListener,
                                      boolean collateMessages,
                                      boolean manageHibernate)

Runs an action sequence. This method uses the base URL set by the Application Context

Parameters:

description - An identifier for this process. This is used for auditing and logging purposes only.

session - The user session that is requesting this execution. This is used for auditing and logging and also can be used in action sequences (for example to filter data)

actionSequence - Path to the action sequence file

parameters - Parameters to be passed to the action sequence

outputStream - The output stream for content generated by the action sequence. Can be null.

execListener - An execution listener for feedback during execution. Can be null.

Returns:

doAction

public static boolean doAction(String solutionName,
                               String actionPath,
                               String actionName,
                               String processId,
                               IParameterProvider parameterProvider,
                               OutputStream outputStream,
                               IPentahoSession userSession,
                               ArrayList messages,
                               ILogger logger)

doAction executes an action within the bi platform and returns true if successful. Snagged from ChartHelper

Parameters:

solutionName - the solution name

actionPath - the action path

actionName - the action name

processId - the process id

parameterProvider - the collection of parameters to customize the chart

outputStream - the output object

userSession - the user session object

messages - a collection to store error and logging messages

logger - logging object

Returns:

the runtime context

doAction

public static IRuntimeContext doAction(String solutionName,
                                       String actionPath,
                                       String actionName,
                                       String processId,
                                       IParameterProvider parameterProvider,
                                       IPentahoSession userSession,
                                       ArrayList messages,
                                       ILogger logger)

doAction executes an action within the bi platform and returns the runtime context. Snagged from ChartHelper

Parameters:

solutionName - the solution name

actionPath - the action path

actionName - the action name

processId - the process id

parameterProvider - the collection of parameters to customize the chart

userSession - the user session object

messages - a collection to store error and logging messages

logger - logging object

Returns:

the runtime context