|
Oracle® Data Integrator Java API Reference 11g Release 1 (11.1.1.3.0) E17060-01 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IJobDefinitionRepository
Repository interface to manage storage of JobDefinition
s.
Method Summary | |
---|---|
oracle.as.scheduler.JobDefinition |
createNewJobDefinition(java.lang.String pJobName,
OdiScenario pScenario,
StartupParameters pVariables)
Create an store a new ODI job definition for the given scenario and execution variables. |
oracle.as.scheduler.JobDefinition |
createNewJobDefinition(java.lang.String pJobName,
OdiScenario pScenario,
StartupParameters pVariables,
java.lang.Integer pLogLevel,
OdiLogicalAgent pAgent,
OdiContext pExecutionContext,
java.lang.String pRunAsId,
boolean pIsAsync)
Create an store a new ODI job definition for the given scenario and execution parameters. |
oracle.as.scheduler.JobDefinition |
createNewJobDefinition(java.lang.String pJobName,
OdiScenario pScenario,
StartupParameters pVariables,
java.lang.String pRunAsId,
boolean pIsAsync)
Create an store a new ODI job definition for the given scenario and execution variables. |
oracle.as.scheduler.JobDefinition |
createNewJobDefinition(java.lang.String pJobName,
java.lang.String pScenarioName,
java.lang.String pScenarioVersion,
StartupParameters pVariables)
Same as createNewJobDefinition(String, OdiScenario, StartupParameters) , but allow
for specification of the scenario using its name and version (which are unique key
for OdiScenarios). |
oracle.as.scheduler.JobDefinition |
createNewJobDefinition(java.lang.String pJobName,
java.lang.String pScenarioName,
java.lang.String pScenarioVersion,
StartupParameters pVariables,
java.lang.Integer pLogLevel,
java.lang.String pLogicalAgentName,
java.lang.String pContextCode,
java.lang.String pRunAsId,
boolean pIsAsync)
Same as createNewJobDefinition(String, OdiScenario, StartupParameters, Integer, OdiLogicalAgent, OdiContext, String, Password)
but allow for specification of the scenario, agent and context using their unique key and code. |
oracle.as.scheduler.JobDefinition |
createNewJobDefinition(java.lang.String pJobName,
java.lang.String pScenarioName,
java.lang.String pScenarioVersion,
StartupParameters pVariables,
java.lang.String pRunAsId,
boolean pIsAsync)
Same as createNewJobDefinition(String, OdiScenario, StartupParameters) , but allow
for specification of the scenario using its name and version (which are unique key
for OdiScenarios). |
java.util.Collection<oracle.as.scheduler.JobDefinition> |
getAllJobDefinitions()
Obtain an unmodifiable collection of all job definition this repository instance contains. |
oracle.as.scheduler.JobDefinition |
getJobDefinitionForId(oracle.as.scheduler.MetadataObjectId pJobId)
Obtains the job definition with the given ID from this repository instance. |
oracle.as.scheduler.JobDefinition |
getJobDefinitionForName(java.lang.String pJobName)
Obtains the job definition with the given name from this repository instance. |
java.util.Collection<oracle.as.scheduler.JobDefinition> |
getJobDefinitionForScenario(OdiScenario pScenario)
Obtains an unmodifiable collection of jobs that apply for the given scenario (i.e. |
java.util.Collection<oracle.as.scheduler.JobDefinition> |
getJobDefinitionsForScenarioNameAndVersion(java.lang.String pName,
java.lang.String pVersion)
Obtains an unmodifiable collection of jobs that apply for the given scenario name and version (i.e. |
void |
removeJobDefinition(oracle.as.scheduler.JobDefinition pJobDefinition)
Remove the given job definition from this repository instance. |
void |
updateJobDefinition(oracle.as.scheduler.JobDefinition pJobDefinition)
Update the given job definition from this repository instance. |
Method Detail |
---|
oracle.as.scheduler.JobDefinition createNewJobDefinition(java.lang.String pJobName, OdiScenario pScenario, StartupParameters pVariables) throws DuplicateJobDefinitionException
That is the common method to be used in order to create a design time job definition. Specific execution / runtime parameters like execution agent, execution context, ODI user, etc. have to be defined at job submission time.
Note: for consistency with the current IRepositoryDefinition
used to access the domain
layer, this method sets job's work repository parameter with the current one using
IRepositoryDefinition.getWorkRepositoryName()
. However that job parameter can be overrided
at job submission time for specific use case where job definitions and scenarios have been exported
and imported from an ODI / ESS environment to another one and possibly having another work repository
name.
pJobName
- the name of the ESS jobpScenario
- the ODI scenario to be executed when submitting that jobpVariables
- the execution variables to be used during execution of the specified scenario
DuplicateJobDefinitionException
- if a job with the same name already exist
java.lang.IllegalStateException
- if this repository instance cannot define the work repository where execution will occur
java.lang.IllegalArgumentException
- if the job name is null
or empty
java.lang.IllegalArgumentException
- if the scenario is null
java.lang.IllegalArgumentException
- if the execution variables is null
. Use default constuctor for an empty StartupParameters
instance.oracle.as.scheduler.JobDefinition createNewJobDefinition(java.lang.String pJobName, OdiScenario pScenario, StartupParameters pVariables, java.lang.Integer pLogLevel, OdiLogicalAgent pAgent, OdiContext pExecutionContext, java.lang.String pRunAsId, boolean pIsAsync) throws DuplicateJobDefinitionException
Overload createNewJobDefinition(String, OdiScenario, StartupParameters)
to allow
specification of runtime job parameters like execution agent, execution context, ODI user, etc.
However those parameters can still be overrided at job submission time.
pJobName
- the ESS job namepScenario
- the ODI scenario to be executedpVariables
- the execution variables to be used during execution of the specified scenariopLogLevel
- log level of the executionpAgent
- target logical agent where to execute the specified scenariopExecutionContext
- ODI execution context for the specified agent and scenariopRunAsId
- applicationId to runAs, if null, runs as submitting userpIsAsync
- whether execution is asynchronous or not
DuplicateJobDefinitionException
- if a job with the same name already exist
java.lang.IllegalStateException
- if this repository instance cannot define the work repository where execution will occur
java.lang.IllegalArgumentException
- if ESS job name parameter is null
or empty
java.lang.IllegalArgumentException
- if ODI scenario is null
java.lang.IllegalArgumentException
- if execution variables is null
(use default constructor for empty execution variables)createNewJobDefinition(String, OdiScenario, StartupParameters)
oracle.as.scheduler.JobDefinition createNewJobDefinition(java.lang.String pJobName, OdiScenario pScenario, StartupParameters pVariables, java.lang.String pRunAsId, boolean pIsAsync) throws DuplicateJobDefinitionException
That is the common method to be used in order to create a design time job definition. Specific execution / runtime parameters like execution agent, execution context, ODI user, etc. have to be defined at job submission time.
Note: for consistency with the current IRepositoryDefinition
used to access the domain
layer, this method sets job's work repository parameter with the current one using
IRepositoryDefinition.getWorkRepositoryName()
. However that job parameter can be overrided
at job submission time for specific use case where job definitions and scenarios have been exported
and imported from an ODI / ESS environment to another one and possibly having another work repository
name.
pJobName
- the name of the ESS jobpScenario
- the ODI scenario to be executed when submitting that jobpVariables
- the execution variables to be used during execution of the specified scenariopRunAsId
- applicationId to runAs, if null, runs as submitting userpIsAsync
- whether execution is asynchronous or not
DuplicateJobDefinitionException
- if a job with the same name already exist
java.lang.IllegalStateException
- if this repository instance cannot define the work repository where execution will occur
java.lang.IllegalArgumentException
- if the job name is null
or empty
java.lang.IllegalArgumentException
- if the scenario is null
java.lang.IllegalArgumentException
- if the execution variables is null
. Use default constuctor for an empty StartupParameters
instance.oracle.as.scheduler.JobDefinition createNewJobDefinition(java.lang.String pJobName, java.lang.String pScenarioName, java.lang.String pScenarioVersion, StartupParameters pVariables) throws DuplicateJobDefinitionException
createNewJobDefinition(String, OdiScenario, StartupParameters)
, but allow
for specification of the scenario using its name and version (which are unique key
for OdiScenarios).
pJobName
- the name of the ESS jobpScenarioName
- the name of the scenario to be executed when submitting that jobpScenarioVersion
- the version of the scenario to be executed when submitting that jobpVariables
- the execution variables to be used during execution of the specified scenario
DuplicateJobDefinitionException
- if a job with the same name already exist
java.lang.IllegalStateException
- if this repository instance cannot define the work repository where execution will occur
java.lang.IllegalArgumentException
- if the job name is null
or empty
java.lang.IllegalArgumentException
- if the scenario's name is null
or empty
java.lang.IllegalArgumentException
- if the scenario's version is null
or empty
java.lang.IllegalArgumentException
- if the execution variables is null
. Use default constructor for an empty StartupParameters
instance.createNewJobDefinition(String, OdiScenario, StartupParameters)
oracle.as.scheduler.JobDefinition createNewJobDefinition(java.lang.String pJobName, java.lang.String pScenarioName, java.lang.String pScenarioVersion, StartupParameters pVariables, java.lang.Integer pLogLevel, java.lang.String pLogicalAgentName, java.lang.String pContextCode, java.lang.String pRunAsId, boolean pIsAsync) throws DuplicateJobDefinitionException
createNewJobDefinition(String, OdiScenario, StartupParameters, Integer, OdiLogicalAgent, OdiContext, String, Password)
but allow for specification of the scenario, agent and context using their unique key and code.
pJobName
- the name of the ESS jobpScenarioName
- the name of the scenario to be executed when submitting that jobpScenarioVersion
- the version of the scenario to be executed when submitting that jobpVariables
- the execution variables to be used during execution of the specified scenariopLogLevel
- log level of the executionpLogicalAgentName
- target logical agent where to execute the specified scenariopContextCode
- ODI execution context for the specified agent and scenariopRunAsId
- applicationId to runAs, if null, runs as submitting userpIsAsync
- whether execution is asynchronous or not
DuplicateJobDefinitionException
- if a job with the same name already exist
java.lang.IllegalStateException
- if this repository instance cannot define the work repository where execution will occur
java.lang.IllegalArgumentException
- if the job name is null
or empty
java.lang.IllegalArgumentException
- if the scenario's name is null
or empty
java.lang.IllegalArgumentException
- if the scenario's version is null
or empty
java.lang.IllegalArgumentException
- if the execution variables is null
. Use default constructor for an empty StartupParameters
instance.createNewJobDefinition(String, OdiScenario, StartupParameters, Integer, OdiLogicalAgent, OdiContext, String, Password)
oracle.as.scheduler.JobDefinition createNewJobDefinition(java.lang.String pJobName, java.lang.String pScenarioName, java.lang.String pScenarioVersion, StartupParameters pVariables, java.lang.String pRunAsId, boolean pIsAsync) throws DuplicateJobDefinitionException
createNewJobDefinition(String, OdiScenario, StartupParameters)
, but allow
for specification of the scenario using its name and version (which are unique key
for OdiScenarios).
pJobName
- the name of the ESS jobpScenarioName
- the name of the scenario to be executed when submitting that jobpScenarioVersion
- the version of the scenario to be executed when submitting that jobpVariables
- the execution variables to be used during execution of the specified scenariopRunAsId
- applicationId to runAs, if null, runs as submitting userpIsAsync
- whether execution is asynchronous or not
DuplicateJobDefinitionException
- if a job with the same name already exist
java.lang.IllegalStateException
- if this repository instance cannot define the work repository where execution will occur
java.lang.IllegalArgumentException
- if the job name is null
or empty
java.lang.IllegalArgumentException
- if the scenario's name is null
or empty
java.lang.IllegalArgumentException
- if the scenario's version is null
or empty
java.lang.IllegalArgumentException
- if the execution variables is null
. Use default constructor for an empty StartupParameters
instance.createNewJobDefinition(String, OdiScenario, StartupParameters)
java.util.Collection<oracle.as.scheduler.JobDefinition> getAllJobDefinitions()
oracle.as.scheduler.JobDefinition getJobDefinitionForId(oracle.as.scheduler.MetadataObjectId pJobId) throws JobDefinitionNotFoundException
pJobId
- the ID of the job
JobDefinitionNotFoundException
- if not job found with the given IDoracle.as.scheduler.JobDefinition getJobDefinitionForName(java.lang.String pJobName) throws JobDefinitionNotFoundException
pJobName
- the name of the job
JobDefinitionNotFoundException
- if no job found with the given namejava.util.Collection<oracle.as.scheduler.JobDefinition> getJobDefinitionForScenario(OdiScenario pScenario)
pScenario
- the scenario
java.util.Collection<oracle.as.scheduler.JobDefinition> getJobDefinitionsForScenarioNameAndVersion(java.lang.String pName, java.lang.String pVersion)
pName
- the scenario namepVersion
- the scenario version
void removeJobDefinition(oracle.as.scheduler.JobDefinition pJobDefinition)
Note: if this repository doesn't contains this job, this method will simply return.
pJobDefinition
- the job to removevoid updateJobDefinition(oracle.as.scheduler.JobDefinition pJobDefinition) throws JobDefinitionNotFoundException
pJobDefinition
- the job to update
JobDefinitionNotFoundException
- if this repository doesn't contains this job
|
Oracle® Data Integrator Java API Reference 11g Release 1 (11.1.1.3.0) E17060-01 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |