| org.pentaho.core.solution.ISolutionEngine
All known Subclasses: org.pentaho.core.solution.SolutionEngine,
| ISolutionEngine | | public interface ISolutionEngine extends ILogger(Code) | | 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.
|
| Method Summary | |
| public IRuntimeContext | execute(String solutionName, String actionPath, String actionName, String processId, boolean async, boolean instanceEnds, String instanceId, boolean persisted, Map parameterProviderMap, IOutputHandler outputHandler, IActionCompleteListener listener, IPentahoUrlFactory urlFactory, List messages)
| | public IRuntimeContext | execute(IRuntimeContext runtime, String solutionName, String sequencePath, String sequenceName, String processId, boolean async, boolean instanceEnds, Map parameterProviderMap, IOutputHandler outputHandler)
| | public IRuntimeContext | execute(String actionSequenceXML, String sequenceName, String processId, boolean async, boolean instanceEnds, String instanceId, boolean persisted, Map parameterProviderMap, IOutputHandler outputHandler, IActionCompleteListener pListener, IPentahoUrlFactory urlFactory, List messages)
| | public IRuntimeContext | getExecutionContext()
| | public int | getStatus()
| | public void | init(IPentahoSession session)
Initialize the SolutionEngine. | | public void | setForcePrompt(boolean forcePrompt)
| | public void | setParameterProvider(String name, IParameterProvider parameterProvider)
Sets the source for input parameters. | | public void | setParameterXsl(String xsl)
Sets the xsl file to be used to generate the parameter page for the
current component. | | public void | setSession(IPentahoSession session)
| | public void | setlistener(IActionCompleteListener listener)
|
| RUNTIME_SOLUTION_NAME | | final public static String RUNTIME_SOLUTION_NAME(Code) | | |
| execute | | public IRuntimeContext execute(String solutionName, String actionPath, String actionName, String processId, boolean async, boolean instanceEnds, String instanceId, boolean persisted, Map parameterProviderMap, IOutputHandler outputHandler, IActionCompleteListener listener, IPentahoUrlFactory urlFactory, List messages)(Code) | | Executes the action sequence specified in the manner described in the
parameters
Parameters:
solutionName - the name at the root level of the solution path
Parameters:
actionPath - the path relative to the solutionName that will lead to therequested action
Parameters:
actionName - name of the action sequence document
Parameters:
processId - id for the given action sequence document
Parameters:
async - synchronous(false) or asynchronous(true) execution (notcurrently used)
Parameters:
instanceId - id to be handed to the runtime repository
Parameters:
persisted - if true, store runtime data, otherwise do not
Parameters:
parameterProviderMap - group of ParameterProviders, sources for inout parameters
Parameters:
outputHandler - handler used to query for addition parameters
Parameters:
listener - object notified on completion of action sequences
Parameters:
urlFactory - factory for building urls
Parameters:
messages - list into which debug, info, warning, and errors messages willbe added IRuntimeContext the RuntimeContext associated with this actionsequence execution
See Also: org.pentaho.core.runtime.IRuntimeContext |
| execute | | public IRuntimeContext execute(IRuntimeContext runtime, String solutionName, String sequencePath, String sequenceName, String processId, boolean async, boolean instanceEnds, Map parameterProviderMap, IOutputHandler outputHandler)(Code) | | Executes the action sequence specified
Parameters:
runtime - The runtime context for the execution
Parameters:
solutionName - Name of the solution
Parameters:
sequencePath - path to the solution
Parameters:
sequenceName - name of the action sequence
Parameters:
processId - id for the given process, typically a GUID or unique id for this execution
Parameters:
async - true if the execution should be asynchronous.
Parameters:
instanceEnds - currently true indicating that the process ends with this execution
Parameters:
parameterProviderMap - Map of parameter providers to use for the execution
Parameters:
outputHandler - The output handler for dealing with user feedback The runtime context for the execution
See Also: IRuntimeContext
See Also: IParameterProvider
See Also: IActionSequence |
| execute | | public IRuntimeContext execute(String actionSequenceXML, String sequenceName, String processId, boolean async, boolean instanceEnds, String instanceId, boolean persisted, Map parameterProviderMap, IOutputHandler outputHandler, IActionCompleteListener pListener, IPentahoUrlFactory urlFactory, List messages)(Code) | | Executes the in memory action sequence specified
Parameters:
actionSequenceXML - the in memory action sequence string
Parameters:
sequenceName - name of the action sequence
Parameters:
processId - id for the given process, typically a GUID or unique id for this execution
Parameters:
async - true if the execution should be asynchronous.
Parameters:
instanceEnds - currently true indicating that the process ends with this execution
Parameters:
parameterProviderMap - Map of parameter providers to use for the execution
Parameters:
outputHandler - The output handler for dealing with user feedback The runtime context for the execution
See Also: IRuntimeContext
See Also: IParameterProvider
See Also: IActionSequence |
| getExecutionContext | | public IRuntimeContext getExecutionContext()(Code) | | the runtime context being used for this execution. |
| getStatus | | public int getStatus()(Code) | | Gets the current status from this execution |
| init | | public void init(IPentahoSession session)(Code) | | 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 |
| setForcePrompt | | public void setForcePrompt(boolean forcePrompt)(Code) | | Sets if the promp page should be forced
Parameters:
status - |
| setParameterXsl | | public void setParameterXsl(String xsl)(Code) | | 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 |
| setSession | | public void setSession(IPentahoSession session)(Code) | | Sets the session in the solution engine
Parameters:
session - The session for this execution |
| setlistener | | public void setlistener(IActionCompleteListener listener)(Code) | | Sets the action complete listener which will be called when the action is complete
Parameters:
listener - Listener to call back when execution is complete. |
|
|