oracle.odi.domain.mapping.generator

Class TaskControl

java.lang.Object

oracle.odi.domain.mapping.generator.TaskControl

public class TaskControl
extends java.lang.Object

A class used to control session task instantiation for the KM task line. A TaskControl instance is available in the KM task-local groovy script, as a built-in variable. Use the skipTaskGeneration() method to disable generation of a session task for the KM task. Use instantiateTask() to add an extra session task instantiation for the KM task

Method Summary

Modifier and Type	Method and Description
void	instantiateTask(java.util.Map variableMap) Add an extra instance of this task to the generated session.
void	instantiateTask(java.lang.String taskName, java.util.Map variableMap) Add an extra instance of this task to the generated session.
boolean	isSkipTaskGeneration() Return true if the skip task generation flag has been set, else return false.
void	setSourceLogicalSchema(oracle.odi.domain.adapter.topology.ILogicalSchema logSchema) Set a logical schema that will override the KM line source logical schema setting for the current task usage.
void	setTargetLogicalSchema(oracle.odi.domain.adapter.topology.ILogicalSchema logSchema) Set a logical schema that will override the KM line target logical schema setting for the current task usage.
void	skipTaskGeneration(boolean value) Set the skip task generation flag.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

skipTaskGeneration

public void skipTaskGeneration(boolean value)

Set the skip task generation flag. If the skip task generation flag is set to true, then no task will be added to the session for the associated KM task, unless extra task instantiations are added using the instantiateTask() call.

Parameters:

value - The boolean value to set.

instantiateTask

public void instantiateTask(java.util.Map variableMap)
                     throws GenerationException

Add an extra instance of this task to the generated session.

Parameters:

variableMap - A hash map whose key is a variable name, and whose value is the variable value. Using this parameter, a different set of variable values can be used when generating the task instance.

Throws:

GenerationException

instantiateTask

public void instantiateTask(java.lang.String taskName,
                            java.util.Map variableMap)
                     throws GenerationException

Add an extra instance of this task to the generated session.

Parameters:

variableMap - A hash map whose key is a variable name, and whose value is the variable value. Using this parameter, a different set of variable values can be used when generating the task instance.

Throws:

GenerationException

isSkipTaskGeneration

public boolean isSkipTaskGeneration()

Return true if the skip task generation flag has been set, else return false. If the flag is true, a session task will not be generated for this task.

setSourceLogicalSchema

public void setSourceLogicalSchema(oracle.odi.domain.adapter.topology.ILogicalSchema logSchema)

Set a logical schema that will override the KM line source logical schema setting for the current task usage. Allows the source logical schema for the task to be dynamically set during KM processing for code generation.

Parameters:

logSchema - The source logical schema to set for the current KM line usage.

setTargetLogicalSchema

public void setTargetLogicalSchema(oracle.odi.domain.adapter.topology.ILogicalSchema logSchema)

Set a logical schema that will override the KM line target logical schema setting for the current task usage. Allows the target logical schema for the task to be dynamically set during KM processing for code generation.

Parameters:

logSchema - The source logical schema to set for the current KM line usage.