|
Oracle Fusion Middleware Java API Reference for Oracle WebCenter Portal 11g Release 1 (11.1.1.6.0) E15995-05 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IScenariosService
Service for management and execution of scenarios.
Method Summary | |
---|---|
IScenarioMetadata |
createScenario(ClientContext clientContext, IScenarioStatement statement) Creates a new scenario definition |
void |
deleteScenario(ClientContext clientContext, java.lang.String scenarioName) Deletes a scenario by name. |
java.lang.Object |
executeScenario(ClientContext clientContext, java.lang.String scenarioName, java.util.Map<java.lang.String,java.lang.String> parameters) Executes a scenario by name. |
void |
exportScenario(ClientContext clientContext, java.lang.String directoryPath, java.lang.String scenarioName) Exports a scenario by name for a given namespace to the specified directory. |
IScenarioMetadata |
getScenario(ClientContext clientContext, java.lang.String scenarioName) Retrieves a scenario by name. |
java.util.List<IScenarioMetadata> |
getScenarios(ClientContext clientContext) Retrieves the collection of scenarios for the specified namespace (in ClientContext). |
java.util.List<IScenarioMetadata> |
getScenariosByTag(ClientContext clientContext, java.lang.String tag) Retrieves the collection of scenarios for the specified namespace (in ClientContext) and tag. |
IStatementFactory |
getStatementFactory() Returns the statement factory for constructing scenario statements. |
IScenarioMetadata |
importScenario(ClientContext clientContext, java.io.File file) Imports a scenario definition based on the provided file. |
IScenarioMetadata |
importScenario(ClientContext clientContext, java.net.URL url) Imports a scenario definition based on the provided URL. |
void |
renameScenario(ClientContext clientContext, java.lang.String oldName, java.lang.String newName) Renames an existing scenario. |
IScenarioMetadata |
saveScenario(ClientContext clientContext, IScenarioStatement statement) Saves an existing scenario definition. |
IScenarioStatement |
validateScenario(ClientContext clientContext, IScenarioStatement scenario, boolean throwException) Validates the provided scenario. |
Method Detail |
---|
IStatementFactory getStatementFactory()
IScenarioMetadata getScenario(ClientContext clientContext, java.lang.String scenarioName) throws NoSuchException
clientContext
- The client context to use for namespace, localization, etc.scenarioName
- The scenario name to retrieveNoSuchException
- If the named scenario does not exist.IScenarioMetadata saveScenario(ClientContext clientContext, IScenarioStatement statement) throws NoSuchException, ScenarioCompilationException
clientContext
- The client context to use for namespace, localization, etc.statement
- The scenario definitionNoSuchException
- If the specified scenario does not exist.ScenarioCompilationException
- If scenario has validation errors. The save will be successful, however cannot be executed and it's status will be set to DRAFT.IScenarioMetadata createScenario(ClientContext clientContext, IScenarioStatement statement) throws DuplicateException, ScenarioCompilationException
clientContext
- The client context to use for namespace, localization, etc.statement
- The scenario definitionDuplicateScenarioException
- If the specified named scenario already exists.ScenarioCompilationException
- If scenario has validation errors. The save will be successful, however cannot be executed and it's status will be set to DRAFT.DuplicateException
void deleteScenario(ClientContext clientContext, java.lang.String scenarioName) throws NoSuchException
clientContext
- The client context to use for namespace, localization, etc.scenarioName
- The scenario name to delete.NoSuchException
- If the specified scenario name does not exist.java.util.List<IScenarioMetadata> getScenarios(ClientContext clientContext)
clientContext
- The client context to use for namespace, localization, pagination, etc.java.util.List<IScenarioMetadata> getScenariosByTag(ClientContext clientContext, java.lang.String tag)
clientContext
- The client context to use for namespace, localization, pagination, etc.tag
- The tag to search for.void renameScenario(ClientContext clientContext, java.lang.String oldName, java.lang.String newName) throws NoSuchException, DuplicateException
clientContext
- The client context to use for namespace, localization, etc.oldName
- The current scenario name.newName
- The new name of the scenario.NoSuchException
- If the specified scenario name (denoted by oldName) does not exist.DuplicateScenarioException
- If a scenario already exists (denoted by newName).DuplicateException
java.lang.Object executeScenario(ClientContext clientContext, java.lang.String scenarioName, java.util.Map<java.lang.String,java.lang.String> parameters) throws NoSuchException
clientContext
- The client context to use for namespace, localization, etc.scenarioName
- The named scenario to execute.parameters
- Parameters to be used as input parameters to the scenario.NoSuchException
- If the specified scenario does not exist.IScenarioStatement validateScenario(ClientContext clientContext, IScenarioStatement scenario, boolean throwException) throws ScenarioCompilationException
clientContext
- The client context to use for namespace, localization, etc.scenario
- The scenario definition to validate.throwException
- Indicates that an exception should be thrown if there are validation errors.ScenarioCompilationException
- If scenario has validation errors and throwException is true.IScenarioMetadata importScenario(ClientContext clientContext, java.net.URL url) throws ScenarioCompilationException
If the scenario definition does not exist (by scenario name), it will be created. If the scenario definition does exist, it will be overwritten with the new scenario definition.
Only XML scenario definitions are currently supported.
clientContext
- The client context to use for namespace, localization, etc.url
- The url to the scenario definition in XML.ScenarioCompilationException
- If scenario has validation errors.IScenarioMetadata importScenario(ClientContext clientContext, java.io.File file) throws ScenarioCompilationException
If the scenario definition does not exist (by scenario name), it will be created. If the scenario definition does exist, it will be overwritten with the new scenario definition.
Only XML scenario definitions are currently supported.
clientContext
- The client context to use for namespace, localization, etc.file
- The file to the scenario definition in XML.ScenarioCompilationException
- If scenario has validation errors.void exportScenario(ClientContext clientContext, java.lang.String directoryPath, java.lang.String scenarioName) throws java.io.IOException, NoSuchException
The format of the scenario will be in XML.
clientContext
- The client context to use for namespace, localization, etc.directoryPath
- The directory path to export the scenario to.scenarioName
- The name of the scenario to export.java.io.IOException
- If the specified directory/path does not exist, or is not a directory.NoSuchException
|
Oracle Fusion Middleware Java API Reference for Oracle WebCenter Portal 11g Release 1 (11.1.1.6.0) E15995-05 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |