public class SolutionHelper extends Object
Constructor and Description |
---|
SolutionHelper() |
Modifier and Type | Method and Description |
---|---|
static IRuntimeContext |
doAction(String actionPath,
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 actionPath,
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.
|
public static ISolutionEngine execute(String description, String userId, String actionSequence, Map parameters, OutputStream outputStream)
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.public static ISolutionEngine execute(String description, IPentahoSession session, String actionSequence, Map parameters, OutputStream outputStream)
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.public static ISolutionEngine execute(String description, IPentahoSession session, String actionSequence, Map parameters, OutputStream outputStream, boolean collateMessages)
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 processespublic static ISolutionEngine execute(String description, IPentahoSession session, String actionSequence, Map parameters, OutputStream outputStream, IExecutionListener execListener, boolean collateMessages, boolean manageHibernate)
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.public static boolean doAction(String actionPath, String processId, IParameterProvider parameterProvider, OutputStream outputStream, IPentahoSession userSession, ArrayList messages, ILogger logger)
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 objectpublic static IRuntimeContext doAction(String actionPath, String processId, IParameterProvider parameterProvider, IPentahoSession userSession, ArrayList messages, ILogger logger)
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 objectCopyright © 2017 Hitachi Vantara. All rights reserved.