Interface TransformationScenarioInvoker
-
- All Known Subinterfaces:
AuthorEditorAccess
,IWebappAuthorEditorAccess
,ScenarioInvoker
,WSEditor
,WSEditorBase
@API(type=NOT_EXTENDABLE, src=PUBLIC) public interface TransformationScenarioInvoker
Invokes a transformation scenario.- Since:
- 15
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
runTransformationScenario(java.lang.String scenarioName, java.util.Map<java.lang.String,java.lang.String> scenarioParameters, TransformationFeedback transformationFeedback)
Run specific already defined transformation scenario with custom values for parameters.void
runTransformationScenarios(java.lang.String[] scenarioNames, TransformationFeedback transformationFeedback)
Run specific already defined transformation scenarios.void
stopCurrentTransformationScenario()
Stops the current transformation scenario.
-
-
-
Method Detail
-
runTransformationScenarios
void runTransformationScenarios(java.lang.String[] scenarioNames, TransformationFeedback transformationFeedback) throws TransformationScenarioNotFoundException
Run specific already defined transformation scenarios. A separate thread is started and runs each scenario sequentially. The method returns immediately.- Parameters:
scenarioNames
- An array of scenario names defined in the document type associated to the current editor.transformationFeedback
- An interface through which the user receives feedback from the started transformation process.- Throws:
TransformationScenarioNotFoundException
- If one of the scenarios is not found.
-
runTransformationScenario
void runTransformationScenario(java.lang.String scenarioName, java.util.Map<java.lang.String,java.lang.String> scenarioParameters, TransformationFeedback transformationFeedback) throws TransformationScenarioNotFoundException
Run specific already defined transformation scenario with custom values for parameters. A separate thread is started and runs each scenario sequentially. The method returns immediately.- Parameters:
scenarioName
- The scenario name defined in the document type associated to the current editor.scenarioParameters
- Pairs of transformation scenario names and values that will be used when running this transformation.transformationFeedback
- An interface through which the user receives feedback from the started transformation process.- Throws:
TransformationScenarioNotFoundException
- If the transformation scenario is not found.- Since:
- 25.0
-
stopCurrentTransformationScenario
void stopCurrentTransformationScenario()
Stops the current transformation scenario.- Since:
- 25.0
-
-