oracle.odi.domain.project

Class OdiKM

java.lang.Object

AbstractOdiEntity

oracle.odi.domain.project.OdiProcedure

oracle.odi.domain.project.OdiKM

All Implemented Interfaces:

IFlexFieldUser, IModelObject, IModelObjectBase, IKnowledgeModule, IProcedure, IOdiEntity, IRepositoryEntity, IWorkDevelopmentOdiEntity

Direct Known Subclasses:

AbstractComponentKM, OdiJKM, OdiRKM

public abstract class OdiKM
extends OdiProcedure
implements IKnowledgeModule

Abstract base class that all knowledge modules types subclasses.

Since:

11.1.1.3.0

Nested Class Summary

Nested classes/interfaces inherited from interface oracle.odi.domain.adapter.project.IKnowledgeModule

IKnowledgeModule.KMType, IKnowledgeModule.LKMType, IKnowledgeModule.ProcessingType

Field Summary

Fields inherited from class oracle.odi.domain.project.OdiProcedure

NAME_MAX_LENGTH

Fields inherited from interface oracle.odi.domain.adapter.project.IKnowledgeModule

INTG_TYPE_CONTROL_APPEND, INTG_TYPE_INCREMENTAL_UPDATE, INTG_TYPE_INTERMEDIATE_COMPONENT, INTG_TYPE_NONE, INTG_TYPE_SCD, LOCAL_VARIABLES_GROOVY_SCRIPT

Method Summary

Modifier and Type	Method and Description
int	getChecksum() Return the checksum value stored for this KM.
int	getCustomizationStatus() Returns the status of a KM based on its checksum.
java.lang.String	getKMBuildNumber() Return the build number stored for this KM.
java.lang.String	getProducedASTClassName() Gets the abstract syntax tree class name that is produced by this KM, if any, else null.
OdiProject	getProject() Returns the parent OdiProject.
IRepositoryEntity	getSecurityContainer()
OdiLanguage	getSourceLanguage() Get the source language associated with this KM, or null if no source language is set.
OdiLanguage	getTargetLanguage() Get the target language associated with this KM, or null if no target language is set.
boolean	isDefaultKM() Return whether this KM is the default KM for its pair of source / target technologies, or not (c.f.
boolean	isGlobal() Returns whether this OdiKm has global scope, or not (i.e.
boolean	isInstanceLevelSecurityNeeded() Internal: this method is for internal purpose and must not be considered as part of the public API.
boolean	isSeeded() Return true if this KM is a shipped, seeded 12c (or later) KM.
boolean	isSetBasedOperatorSupported() Return whether this KM supports set based operator Defines whether this KM supports set based operator (i.e.
void	setChecksum(int pChecksum) Sets this KM's checksum
void	setDefaultKM(boolean pDefaultKM) Defines whether this KM is the default KM for its pair of source / target technologies, or not (c.f.
void	setKMBuildNumber(java.lang.String pBuildNumber) Sets build number for this KM.
void	setProject(OdiProject pProject) Sets the parent OdiProject.
void	setSetBasedOperatorSupported(boolean pSetBasedOperatorSupported) Defines whether this KM supports set based operator (i.e.
java.lang.String	toString()

Methods inherited from class oracle.odi.domain.project.OdiProcedure

addLine, addLine, addLine, addLine, addOption, addOption, addOptionGroup, addProcedureLine, addProcedureLine, addProcedureOption, dumpLineOrder, duplicateLine, duplicateOption, getDefaultSourceTechnology, getDefaultTargetTechnology, getDescription, getFlexFieldsValues, getInternalId, getLines, getLineType, getName, getOption, getOptionGroup, getOptionGroups, getOptionNames, getOptions, getOptionsWithNoGroup, getProcedureId, getProcedureOption, getProcedureOptions, getTopLevelLines, initFlexFields, isMultiConnectionSupported, isProcedureLine, moveGroupAfterGroup, moveGroupBeforeGroup, moveLineAfter, moveLineBefore, moveLineToBottom, moveLineToTop, moveOptionAfter, moveOptionBefore, moveOptionToBottom, moveOptionToTop, removeLine, removeOption, removeOptionGroup, removeProcedureLine, setDefaultSourceTechnology, setDefaultTargetTechnology, setDescription, setMultiConnectionSupported, setName

Methods inherited from class java.lang.Object

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

Methods inherited from interface oracle.odi.domain.adapter.project.IKnowledgeModule

addProcedureOption, getDescription, getIntegrationType, getKMType, getLKMType, getProcedureLines, getProcedureOption, getProcedureOptions, getProcessingType, isMultiConnectionSupported

Methods inherited from interface oracle.odi.domain.adapter.project.IProcedure

addOptionGroup, addProcedureLine, addProcedureLine, addProcedureOption, getOptionGroup, removeProcedureLine

Methods inherited from interface oracle.odi.domain.adapter.IModelObject

getName

Methods inherited from interface oracle.odi.domain.adapter.IModelObjectBase

getBigNumericId, getGlobalId, getNumericId

Methods inherited from interface oracle.odi.domain.IOdiEntity

getFirstDate, getFirstUser, getLastDate, getLastUser

Methods inherited from interface oracle.odi.domain.IRepositoryEntity

getGlobalId, getParent

Method Detail

getSecurityContainer

public IRepositoryEntity getSecurityContainer()

Specified by:

getSecurityContainer in interface IRepositoryEntity

Overrides:

getSecurityContainer in class OdiProcedure

Returns:

container entity

getProject

public OdiProject getProject()

Returns the parent OdiProject.

Returns:

OdiProject

See Also:

OdiProject, setProject(OdiProject)

isInstanceLevelSecurityNeeded

public boolean isInstanceLevelSecurityNeeded()

Description copied from interface: IOdiEntity

Internal: this method is for internal purpose and must not be considered as part of the public API.

Defines a method to capture the info on which object needs instance level privilege.

Specified by:

isInstanceLevelSecurityNeeded in interface IOdiEntity

Returns:

true if instance level security needed, false otherwise

setProject

public void setProject(OdiProject pProject)

Sets the parent OdiProject.

Parameters:

pProject - owning project. If null, defines a KM having global scope.

See Also:

OdiProject, getProject()

isDefaultKM

public boolean isDefaultKM()

Return whether this KM is the default KM for its pair of source / target technologies, or not (c.f. defaultSourceTechnology and defaultTargetTechnology inherited from OdiProcedure).

Returns:

true if this KM is the default KM for its pair of source / target technologies

See Also:

setDefaultKM(boolean)

setDefaultKM

public void setDefaultKM(boolean pDefaultKM)

Defines whether this KM is the default KM for its pair of source / target technologies, or not (c.f. defaultSourceTechnology and defaultTargetTechnology inherited from OdiProcedure).

Parameters:

pDefaultKM - true to set this KM as the default KM for its pair of source / target technologies

See Also:

isDefaultKM()

setSetBasedOperatorSupported

public void setSetBasedOperatorSupported(boolean pSetBasedOperatorSupported)

Defines whether this KM supports set based operator (i.e. ODI Interface Data Set), or not.

Parameters:

pSetBasedOperatorSupported - true if this KM supports set based operator

See Also:

isSetBasedOperatorSupported()

isSetBasedOperatorSupported

public boolean isSetBasedOperatorSupported()

Return whether this KM supports set based operator Defines whether this KM supports set based operator (i.e. ODI Interface Data Set), or not.

Returns:

true if this KM supports set based operator

See Also:

setSetBasedOperatorSupported(boolean)

isGlobal

public boolean isGlobal()

Returns whether this OdiKm has global scope, or not (i.e. whether there is a owning OdiProject or not).

Returns:

true if this km is global, false otherwise

getKMBuildNumber

public java.lang.String getKMBuildNumber()

Return the build number stored for this KM.

setKMBuildNumber

public void setKMBuildNumber(java.lang.String pBuildNumber)

Sets build number for this KM.

getChecksum

public int getChecksum()

Return the checksum value stored for this KM.

setChecksum

public void setChecksum(int pChecksum)

Sets this KM's checksum

getCustomizationStatus

public int getCustomizationStatus()

Returns the status of a KM based on its checksum.

Returns:

If it is a user created KM, return 0. If it is as provided by Oracle teams, return 1. If it has been modified, return 2.

isSeeded

public boolean isSeeded()

Return true if this KM is a shipped, seeded 12c (or later) KM. In this case it should not be edited.

Returns:

getProducedASTClassName

public java.lang.String getProducedASTClassName()

Description copied from interface: IKnowledgeModule

Gets the abstract syntax tree class name that is produced by this KM, if any, else null.

Specified by:

getProducedASTClassName in interface IKnowledgeModule

Returns:

the class name for the abstract syntax tree produced by this KM.

toString

public java.lang.String toString()

getSourceLanguage

public OdiLanguage getSourceLanguage()

Description copied from interface: IKnowledgeModule

Get the source language associated with this KM, or null if no source language is set.

Specified by:

getSourceLanguage in interface IKnowledgeModule

getTargetLanguage

public OdiLanguage getTargetLanguage()

Description copied from interface: IKnowledgeModule

Get the target language associated with this KM, or null if no target language is set.

Specified by:

getTargetLanguage in interface IKnowledgeModule