public abstract class OdiProcedureLine extends oracle.odi.domain.support.AbstractRepositoryEntity implements IProcedureLine
An OdiProcedureLine is an entity managed within the OdiProcedure, OdiProcedureLine, OdiProcedureLineCmd, ProcedureOption aggregate.
An OdiProcedureLine has an ID (OdiProcedureLineId) that can be obtained from getProcedureLineId() method call. This ID is assigned when an OdiProcedure is stored into design time repository.
This ID represents the identity of an OdiProcedureLine. Equals / hashCode method are implemented according this identity.
The life cycle of an OdiProcedureLine start when it is created and added to the OdiProcedure it belongs. The user can then manipulate it and properties can be defined to fit user requirements: define logging to be applied when executed, target and / or source commands, etc. In order to change a OdiProcedureLine order (i.e. to move it), this has to be done from the OdiProcedure this OdiProcedureLine belongs.
OdiProcedure provides methods for that purpose. The life cycle ends when the OdiProcedureLine is removed from the OdiProcedure it belongs, or when the OdiProcedure owning the OdiProcedureLine is deleted.
Modifier and Type | Class and Description |
---|---|
static class |
OdiProcedureLine.LogCounter
Type safe enum that represents different log counter types defined for a task.
|
static class |
OdiProcedureLine.OdiProcedureLineId
Deprecated.
Deprecated since 12.1.2.0.0 release with no further replacement. Line id is a Number from now and on.
|
IProcedureLine.LineType
Modifier and Type | Field and Description |
---|---|
static int |
NAME_MAX_LENGTH
Maximum length of an OdiProcedureLine name.
|
Modifier and Type | Method and Description |
---|---|
void |
addGenerationCondition(ProcedureOption pOption)
Adds the given ProcedureOption to the collection of options that controls whether this
ProcedureLine will be generated.
|
void |
addGenerationConditionOption(IProcedureOption opt) |
java.util.List |
getGenerationConditionOptions() |
java.util.Collection |
getGenerationConditions()
Obtains an unmodifiable collection of ProcedureOptions that are defined as
conditioning generation of this ProcedureLine.
|
java.io.Serializable |
getInternalId()
Provides a common getter for the persistence layer to obtain an identity,
irrespective of the actual type of identity used.
|
boolean |
getIsSourceExpressionTextEncrypted()
Get the is source command expression text encrypted
|
boolean |
getIsTargetExpressionTextEncrypted()
Get the is target command expression text encrypted
|
IProcedureLine.LineType |
getLineType()
Return the mapping line type for a KM line, if any, else null.
|
OdiProcedureLine.LogCounter |
getLogCounter()
Obtains the LogCounter defined for this ProcedureLine.
|
boolean |
getLogFinalCommand() |
int |
getLogLevel()
Obtains the log level applied to this ProcedureLine.
|
java.lang.String |
getName()
Obtains the name of this ProcedureLine.
|
OdiProcedureLineCmd |
getOnSourceCommand()
Obtains the OdiProcedureLineCmd object that defines the command to be applied
on a source connection.
|
OdiProcedureLineCmd |
getOnTargetCommand()
Obtains the OdiProcedureLineCmd object that defines the command to be applied
on a source connection.
|
int |
getOrder()
Obtains the execution order of this OdiProcedureLine within the list of
OdiProcedureLines that belong to an OdiProcedure.
|
OdiProcedure |
getProcedure()
Returns procedure this line belongs to.
|
IRepositoryEntity |
getSecurityContainer()
Define a generic way to retrieve container for entities.
|
java.lang.String |
getSourceExpressionText()
Get the on source command expression text.
|
java.lang.String |
getSourceExpressionTextEncryptionKey()
Get the source command expression text encryption key
|
java.lang.String |
getSourceExpressionTextEncryptionKeyVector()
Get the source command expression text encryption key vector
|
java.lang.String |
getTargetExpressionText()
Get the on target command expression text.
|
java.lang.String |
getTargetExpressionTextEncryptionKey()
Get the Target command expression text encryption key
|
java.lang.String |
getTargetExpressionTextEncryptionKeyVector()
Get the target command expression text encryption key vector
|
boolean |
isAlwaysGenerated()
Return whether this ProcedureLine is always generated into execution tasks,
without any condition, or not.
|
boolean |
isIgnoreError()
Is ignore error?
|
void |
removeGenerationCondition(ProcedureOption pOption)
Removes the given ProcedureOption to the collection options that controls whether this
OdiProcedureLine will be generated, or not.
|
void |
setAlwaysGenerated(boolean pAlwaysGenerated)
Defines whether this ProcedureLine is always generated into execution tasks.
|
void |
setIgnoreError(boolean ignoreError)
Defines whether this ProcedureLine should ignore error when executed, or not.
If set to true, when an error occurs during exection, the line will go into Warning instead of Error, and the OdiProcedure will not be stopped. |
void |
setLineType(IProcedureLine.LineType type)
Set the mapping line type for a KM line.
|
void |
setLineType(java.lang.String type) |
void |
setLogCounter(OdiProcedureLine.LogCounter logCounter)
Defines the LogCounter type for this ProcedureLine.
|
void |
setLogFinalCommand(boolean pLogFinalCommand) |
void |
setLogLevel(int logLevel)
Defines the log level that will be applied to this ProcedureLine when executed.
|
void |
setName(java.lang.String pName)
Defines the name of this ProcedureLine.
|
void |
setOnSourceCommand(OdiProcedureLineCmd command)
Defines the command to be applied on a source connection.
|
void |
setOnTargetCommand(OdiProcedureLineCmd command)
Defines the command to be applied on a target connection.
|
void |
setSourceExpressionText(java.lang.String value)
Set the on source command expression text.
|
void |
setTargetExpressionText(java.lang.String value)
Set the on target command expression text.
|
equals, getGlobalId, getNumericId, hasCustomizedPersistenceMethodFor, hashCode, invokeCustomizedPersistenceMethodFor, toString
getGlobalId, getNumericId
public static final int NAME_MAX_LENGTH
public OdiProcedure getProcedure()
public IRepositoryEntity getSecurityContainer()
IRepositoryEntity
getSecurityContainer
in interface IRepositoryEntity
public int getOrder()
OdiProcedure.moveLineAfter(OdiProcedureLine, OdiProcedureLine)
,
OdiProcedure.moveLineBefore(OdiProcedureLine, OdiProcedureLine)
public void setLogCounter(OdiProcedureLine.LogCounter logCounter)
logCounter
- LogCounter type for this ProcedureLineDomainRuntimeException
- if given logCounter is null.getLogCounter()
public OdiProcedureLine.LogCounter getLogCounter()
setLogCounter(oracle.odi.domain.project.OdiProcedureLine.LogCounter)
public void setLogLevel(int logLevel)
logLevel
- int value representing the log level for this objectgetLogLevel()
public int getLogLevel()
setLogLevel(int)
public void setIgnoreError(boolean ignoreError)
ignoreError
- true to have this line ignore any errors during executionisIgnoreError()
public boolean isIgnoreError()
setIgnoreError(boolean)
public void setLogFinalCommand(boolean pLogFinalCommand)
public boolean getLogFinalCommand()
public void setAlwaysGenerated(boolean pAlwaysGenerated)
pAlwaysGenerated
- true if this ProcedureLine should always be generated into execution tasksisAlwaysGenerated()
public boolean isAlwaysGenerated()
setAlwaysGenerated(boolean)
public void setName(java.lang.String pName)
pName
- name of OdiProcedureLineDomainRuntimeException
- if name is invalidgetName()
public java.lang.String getTargetExpressionText()
public void setTargetExpressionText(java.lang.String value)
public java.lang.String getSourceExpressionText()
public void setSourceExpressionText(java.lang.String value)
value
- expression text to be setpublic boolean getIsSourceExpressionTextEncrypted()
public java.lang.String getSourceExpressionTextEncryptionKey()
public java.lang.String getSourceExpressionTextEncryptionKeyVector()
public boolean getIsTargetExpressionTextEncrypted()
public java.lang.String getTargetExpressionTextEncryptionKey()
public java.lang.String getTargetExpressionTextEncryptionKeyVector()
public java.lang.String getName()
getName
in interface IModelObject
setName(java.lang.String)
public java.util.Collection getGenerationConditions()
public void addGenerationCondition(ProcedureOption pOption)
pOption
- ProcedureOption to addDomainRuntimeException
- if the given option is null, or does not belongs to the same OdiProcedure than this OdiProcedureLine.removeGenerationCondition(oracle.odi.domain.project.ProcedureOption)
public void removeGenerationCondition(ProcedureOption pOption)
pOption
- ProcedureOption to removeDomainRuntimeException
- if the given option is null, or does not belongs to the same OdiProcedure than this OdiProcedureLine.addGenerationCondition(oracle.odi.domain.project.ProcedureOption)
public OdiProcedureLineCmd getOnSourceCommand()
Note: the returned OdiProcedureLineCmd is a copy of the actual OdiProcedureLineCmd instance. setOnSourceCommand must be called before any of the changes are applied.
This method will never return null.
setOnSourceCommand(oracle.odi.domain.project.OdiProcedureLineCmd)
public void setOnSourceCommand(OdiProcedureLineCmd command)
command
- OdiProcedureLineCmd object to applygetOnSourceCommand()
public OdiProcedureLineCmd getOnTargetCommand()
Note: the returned OdiProcedureLineCmd is a copy of the actual OdiProcedureLineCmd instance. setOnTargetCommand should be called before any of the changes are applied.
This method will never return null.
setOnTargetCommand(oracle.odi.domain.project.OdiProcedureLineCmd)
public void setOnTargetCommand(OdiProcedureLineCmd command)
command
- OdiProcedureLineCmd object to applygetOnTargetCommand()
public java.io.Serializable getInternalId()
IRepositoryEntity
Typically a subclass will delegate to a public
SomePrimitiveWrapper getId()
method. The necessity for the
getInternalId()
abstract method is solely because the
persistence layer needs a way of obtaining the identity irrespective of
the actual identity implementation choice.
Returning null
from this method will indicate the object has
never been saved. This will likely be relied on by some DAO
implementations.
getInternalId
in interface IRepositoryEntity
public java.util.List getGenerationConditionOptions()
getGenerationConditionOptions
in interface IProcedureLine
public void addGenerationConditionOption(IProcedureOption opt)
addGenerationConditionOption
in interface IProcedureLine
public IProcedureLine.LineType getLineType()
getLineType
in interface IProcedureLine
public void setLineType(IProcedureLine.LineType type)
type
- The line type to set for this line.public void setLineType(java.lang.String type)