Skip navigation links

Oracle® Data Integrator Java API Reference
11g Release 1 (11.1.1.7.0)

E17060-04


oracle.odi.generation
Interface IOdiScenarioGenerator

All Known Implementing Classes:
OdiScenarioGeneratorImpl

public interface IOdiScenarioGenerator

Provides all method to generate ODI scenarios.
Example usage:

 .
 .
 IIOdiScenarioGenerator gene = new OdiScenarioGeneratorImpl((odiInstance);
 OdiScenario newScen = gene.generateScenario(pPackage, "MYSCENERIO", "01");
 .
 .
 
Since:
11.1.1.3.0
See Also:
IOdiScenarioSource, IOdiScenarioSourceContainer

Method Summary
 OdiScenario[] generateAllScenarios(IOdiScenarioSourceContainer pScenarioSourceContainer, GenerationOptions pScenGenerationDetails)
          Generates and persists all the scenarii for the scenario sources present in the given scenario source container.
 OdiScenario[] generateAllScenarios(IOdiScenarioSourceContainer pScenarioSourceContainer, GenerationOptions pScenGenerationDetails, boolean pMaterialized)
          Generates and persists all the scenarii for the scenario sources present in the given scenario source container.
 OdiScenario generateScenario(IOdiScenarioSource pSourceObject, java.lang.String pScenarioName, java.lang.String pScenarioVersion)
          Generates and persists in repository a scenario from a given scenario source object.
 OdiScenario generateScenario(IOdiScenarioSource pSourceObject, java.lang.String pScenarioName, java.lang.String pScenarioVersion, boolean pMaterialized)
          Generates and persists in repository a scenario from a given scenario source object.
 void regenerateLatestScenario(java.lang.String pScenarioName)
          Regenerates the latest version of a scenario from its name
 void regenerateLatestScenario(java.lang.String pScenarioName, boolean pMaterialized)
          Regenerates the latest version of a scenario from its name
 void regenerateScenario(OdiScenario pSourceScenario)
          Regenerates a given scenario.
 void regenerateScenario(OdiScenario pSourceScenario, boolean pMaterialized)
          Regenerates a given scenario.
 void regenerateScenario(Tag pSourceScenarioTag)
          Regenerates a given scenario from its tag.
 void regenerateScenario(Tag pSourceScenarioTag, boolean pMaterialized)
          Regenerates a given scenario from its tag.

 

Method Detail

generateScenario

OdiScenario generateScenario(IOdiScenarioSource pSourceObject,
                             java.lang.String pScenarioName,
                             java.lang.String pScenarioVersion)
                             throws OdiScenarioGeneratorException
Generates and persists in repository a scenario from a given scenario source object. The source must have been persisted.

This method will execute in the surrounding transaction and all pending persisted changes will be flushed.

Parameters:
pSourceObject - The object on which the scenario will be based.
pScenarioName - The name of the scenario.
pScenarioVersion - The version of the scenario.
Returns:
the generated scenario (already persisted).
Throws:
OdiScenarioGeneratorException - for errors in the scenario generation including if pScenarioName contains invalid java characters or is longer than 400 chraracters.
IllegalTransactionStateException - if no surrounding transaction exists.

generateScenario

OdiScenario generateScenario(IOdiScenarioSource pSourceObject,
                             java.lang.String pScenarioName,
                             java.lang.String pScenarioVersion,
                             boolean pMaterialized)
                             throws OdiScenarioGeneratorException
Generates and persists in repository a scenario from a given scenario source object. The source must have been persisted.

This method will execute in the surrounding transaction and all pending persisted changes will be flushed.

Parameters:
pSourceObject - The object on which the scenario will be based.
pScenarioName - The name of the scenario.
pScenarioVersion - The version of the scenario.
pMaterialized - True if generating the scenario based on the materialized object of the shortcut.
Returns:
the generated scenario (already persisted).
Throws:
OdiScenarioGeneratorException - for errors in the scenario generation including if pScenarioName contains invalid java characters or is longer than 400 chraracters.
IllegalTransactionStateException - if no surrounding transaction exists.
Since:
11.1.1.7.0

generateAllScenarios

OdiScenario[] generateAllScenarios(IOdiScenarioSourceContainer pScenarioSourceContainer,
                                   GenerationOptions pScenGenerationDetails)
                                   throws OdiScenarioGeneratorException
Generates and persists all the scenarii for the scenario sources present in the given scenario source container. The container must have been persisted.

This method will execute in the surrounding transaction and all pending persisted changes will be flushed.

Parameters:
pScenarioSourceContainer - the given scenario source container.
pScenGenerationDetails - details about the generation.
Returns:
the generated scenarii (already persisted).
Throws:
OdiScenarioGeneratorException
IllegalTransactionStateException - if no surrounding transaction exists.

generateAllScenarios

OdiScenario[] generateAllScenarios(IOdiScenarioSourceContainer pScenarioSourceContainer,
                                   GenerationOptions pScenGenerationDetails,
                                   boolean pMaterialized)
                                   throws OdiScenarioGeneratorException
Generates and persists all the scenarii for the scenario sources present in the given scenario source container. The container must have been persisted.

This method will execute in the surrounding transaction and all pending persisted changes will be flushed.

Parameters:
pScenarioSourceContainer - the given scenario source container.
pScenGenerationDetails - details about the generation.
pMaterialized - True if generating the scenarii based on the materialized objects of the shortcuts.
Returns:
the generated scenarii (already persisted).
Throws:
OdiScenarioGeneratorException
IllegalTransactionStateException - if no surrounding transaction exists.
Since:
11.1.1.7.0

regenerateScenario

void regenerateScenario(OdiScenario pSourceScenario)
                        throws OdiScenarioGeneratorException
Regenerates a given scenario. The scenario must have been persisted.

This method will execute in the surrounding transaction and all pending persisted changes will be flushed.

Parameters:
pSourceScenario - the scenario to regenerate.
Throws:
OdiScenarioGeneratorException
IllegalTransactionStateException - if no surrounding transaction exists.

regenerateScenario

void regenerateScenario(OdiScenario pSourceScenario,
                        boolean pMaterialized)
                        throws OdiScenarioGeneratorException
Regenerates a given scenario. The scenario must have been persisted.

This method will execute in the surrounding transaction and all pending persisted changes will be flushed.

Parameters:
pSourceScenario - the scenario to regenerate.
pMaterialized - True if regenerating the scenario based on the materialized object of the shortcut.
Throws:
OdiScenarioGeneratorException
IllegalTransactionStateException - if no surrounding transaction exists.
Since:
11.1.1.7.0

regenerateScenario

void regenerateScenario(Tag pSourceScenarioTag)
                        throws OdiScenarioGeneratorException
Regenerates a given scenario from its tag.

This method will execute in the surrounding transaction and all pending persisted changes will be flushed.

Parameters:
pSourceScenarioTag - tag identifying the scenario to regenerate.
Throws:
OdiScenarioGeneratorException
OdiScenarioNotFoundException - in case no scenario have been found from given tag
IllegalTransactionStateException - if no surrounding transaction exists.
Since:
11.1.1.5.0

regenerateScenario

void regenerateScenario(Tag pSourceScenarioTag,
                        boolean pMaterialized)
                        throws OdiScenarioGeneratorException
Regenerates a given scenario from its tag.

This method will execute in the surrounding transaction and all pending persisted changes will be flushed.

Parameters:
pSourceScenarioTag - tag identifying the scenario to regenerate.
pMaterialized - True if regenerating the scenario based on the materialized object of the shortcut.
Throws:
OdiScenarioGeneratorException
OdiScenarioNotFoundException - in case no scenario have been found from given tag
IllegalTransactionStateException - if no surrounding transaction exists.
Since:
11.1.1.7.0

regenerateLatestScenario

void regenerateLatestScenario(java.lang.String pScenarioName)
                              throws OdiScenarioGeneratorException
Regenerates the latest version of a scenario from its name

This method will execute in the surrounding transaction and all pending persisted changes will be flushed.

Parameters:
pScenarioName - name of the scenario
Throws:
OdiScenarioGeneratorException
OdiScenarioNotFoundException - in case no scenario is found from the given name
IllegalTransactionStateException - if no surrounding transaction exists.
Since:
11.1.1.5.0

regenerateLatestScenario

void regenerateLatestScenario(java.lang.String pScenarioName,
                              boolean pMaterialized)
                              throws OdiScenarioGeneratorException
Regenerates the latest version of a scenario from its name

This method will execute in the surrounding transaction and all pending persisted changes will be flushed.

Parameters:
pScenarioName - name of the scenario
pMaterialized - True if regenerating the scenario based on the materialized object of the shortcut
Throws:
OdiScenarioGeneratorException
OdiScenarioNotFoundException - in case no scenario is found from the given name
IllegalTransactionStateException - if no surrounding transaction exists.
Since:
11.1.1.7.0

Skip navigation links

Oracle® Data Integrator Java API Reference
11g Release 1 (11.1.1.7.0)

E17060-04


Copyright © 2010, 2013, Oracle and/or its affiliates. All rights reserved.