Class SolutionHelper
- java.lang.Object
-
- org.pentaho.platform.engine.services.solution.SolutionHelper
-
public class SolutionHelper extends Object
-
-
Constructor Summary
Constructors Constructor Description SolutionHelper()
-
Method Summary
All Methods Static Methods Concrete Methods Modifier and Type Method Description static boolean
doAction(String actionPath, String processId, org.pentaho.platform.api.engine.IParameterProvider parameterProvider, OutputStream outputStream, org.pentaho.platform.api.engine.IPentahoSession userSession, ArrayList messages, org.pentaho.platform.api.engine.ILogger logger)
doAction executes an action within the bi platform and returns true if successful.static org.pentaho.platform.api.engine.IRuntimeContext
doAction(String actionPath, String processId, org.pentaho.platform.api.engine.IParameterProvider parameterProvider, org.pentaho.platform.api.engine.IPentahoSession userSession, ArrayList messages, org.pentaho.platform.api.engine.ILogger logger)
doAction executes an action within the bi platform and returns the runtime context.static org.pentaho.platform.api.engine.ISolutionEngine
execute(String description, String userId, String actionSequence, Map parameters, OutputStream outputStream)
Runs an action sequence.static org.pentaho.platform.api.engine.ISolutionEngine
execute(String description, org.pentaho.platform.api.engine.IPentahoSession session, String actionSequence, Map parameters, OutputStream outputStream)
Runs an action sequence.static org.pentaho.platform.api.engine.ISolutionEngine
execute(String description, org.pentaho.platform.api.engine.IPentahoSession session, String actionSequence, Map parameters, OutputStream outputStream, boolean collateMessages)
Runs an action sequence.static org.pentaho.platform.api.engine.ISolutionEngine
execute(String description, org.pentaho.platform.api.engine.IPentahoSession session, String actionSequence, Map parameters, OutputStream outputStream, org.pentaho.platform.api.engine.IExecutionListener execListener, boolean collateMessages, boolean manageHibernate)
Runs an action sequence.
-
-
-
Method Detail
-
execute
public static org.pentaho.platform.api.engine.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 fileparameters
- Parameters to be passed to the action sequenceoutputStream
- The output stream for content generated by the action sequence. Can be null.- Returns:
-
execute
public static org.pentaho.platform.api.engine.ISolutionEngine execute(String description, org.pentaho.platform.api.engine.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 fileparameters
- Parameters to be passed to the action sequenceoutputStream
- The output stream for content generated by the action sequence. Can be null.- Returns:
-
execute
public static org.pentaho.platform.api.engine.ISolutionEngine execute(String description, org.pentaho.platform.api.engine.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 fileparameters
- Parameters to be passed to the action sequenceoutputStream
- 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 org.pentaho.platform.api.engine.ISolutionEngine execute(String description, org.pentaho.platform.api.engine.IPentahoSession session, String actionSequence, Map parameters, OutputStream outputStream, org.pentaho.platform.api.engine.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 fileparameters
- Parameters to be passed to the action sequenceoutputStream
- 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 actionPath, String processId, org.pentaho.platform.api.engine.IParameterProvider parameterProvider, OutputStream outputStream, org.pentaho.platform.api.engine.IPentahoSession userSession, ArrayList messages, org.pentaho.platform.api.engine.ILogger logger)
doAction executes an action within the bi platform and returns true if successful. Snagged from ChartHelper- Parameters:
solutionName
- the solution nameactionPath
- the action pathactionName
- the action nameprocessId
- the process idparameterProvider
- the collection of parameters to customize the chartoutputStream
- the output objectuserSession
- the user session objectmessages
- a collection to store error and logging messageslogger
- logging object- Returns:
- the runtime context
-
doAction
public static org.pentaho.platform.api.engine.IRuntimeContext doAction(String actionPath, String processId, org.pentaho.platform.api.engine.IParameterProvider parameterProvider, org.pentaho.platform.api.engine.IPentahoSession userSession, ArrayList messages, org.pentaho.platform.api.engine.ILogger logger)
doAction executes an action within the bi platform and returns the runtime context. Snagged from ChartHelper- Parameters:
solutionName
- the solution nameactionPath
- the action pathactionName
- the action nameprocessId
- the process idparameterProvider
- the collection of parameters to customize the chartuserSession
- the user session objectmessages
- a collection to store error and logging messageslogger
- logging object- Returns:
- the runtime context
-
-