Skip navigation links

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

E17060-04


oracle.odi.domain.project
Class OdiKM<L extends OdiProcedureLine>

java.lang.Object
  extended by oracle.odi.domain.support.BusinessObject
      extended by oracle.odi.domain.support.AbstractRepositoryEntity
          extended by oracle.odi.domain.support.AbstractOdiEntity
              extended by oracle.odi.domain.project.OdiProcedure<L>
                  extended by oracle.odi.domain.project.OdiKM<L>

All Implemented Interfaces:
java.io.Serializable, java.lang.Cloneable, oracle.odi.core.audit.support.IAuditableFirstClassObject, IFlexFieldUser, IExportable, IOdiEntity, IRepositoryEntity, IWorkDevelopmentOdiEntity, ISmartExportable
Direct Known Subclasses:
OdiCKM, OdiIKM, OdiJKM, OdiLKM, OdiRKM

public abstract class OdiKM<L extends OdiProcedureLine>
extends OdiProcedure<L>
implements IExportable, ISmartExportable, oracle.odi.core.audit.support.IAuditableFirstClassObject

Abstract base class that all knowledge modules types subclasses.

Since:
11.1.1.3.0
See Also:
Serialized Form

Field Summary

 

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

 

Fields inherited from class oracle.odi.domain.support.AbstractOdiEntity
STARTING_INTERNAL_VERSION

 

Method Summary
 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.
 OdiProject getProject()
          Returns the parent OdiProject.
 IRepositoryEntity getSecurityContainer()
          Define a generic way to retrieve container for entities.
 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 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.

 

Methods inherited from class oracle.odi.domain.project.OdiProcedure
addLine, addLine, addOption, addOption, getDefaultSourceTechnology, getDefaultTargetTechnology, getDescription, getFlexFieldsValues, getInternalId, getLines, getName, getOption, getOptionNames, getOptions, getProcedureId, initFlexFields, isMultiConnectionSupported, moveLineAfter, moveLineBefore, removeLine, removeOption, setDefaultSourceTechnology, setDefaultTargetTechnology, setDescription, setMultiConnectionSupported, setName

 

Methods inherited from class oracle.odi.domain.support.AbstractOdiEntity
equals, getFirstDate, getFirstUser, getInternalVersion, getLastDate, getLastUser, hashCode, isNew, toString

 

Methods inherited from class oracle.odi.domain.support.BusinessObject
clone

 

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

 

Methods inherited from interface oracle.odi.domain.IOdiEntity
getFirstDate, getFirstUser, getLastDate, getLastUser

 

Method Detail

getSecurityContainer

public IRepositoryEntity getSecurityContainer()
Description copied from interface: IRepositoryEntity
Define a generic way to retrieve container for entities.
Specified by:
getSecurityContainer in interface IRepositoryEntity
Overrides:
getSecurityContainer in class OdiProcedure<L extends OdiProcedureLine>
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
Overrides:
isInstanceLevelSecurityNeeded in class oracle.odi.domain.support.AbstractOdiEntity
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.

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.