|
Oracle® Data Integrator Java API Reference 11g Release 1 (11.1.1.5.0) E17060-02 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object
oracle.odi.domain.support.BusinessObject
oracle.odi.domain.support.AbstractRepositoryEntity
oracle.odi.domain.support.AbstractOdiEntity
oracle.odi.domain.project.OdiSKM
public final class OdiSKM
Represents the Service Knowledge Module.
SKM (Service Knowledge Modules) are used to generate the code required for creating data services. These KMs are used in data models.
This is not a standard ODI KM and does not extend from OdiProcedure nor OdiKM. An OdiSKM has an ID that can be obtained from getSKMId() method call. This ID is assigned when an OdiSKM is stored into design time repository.
This ID represents the identity of an OdiSKM. Equals / hashCode method are implemented according this identity.
An OdiSKM life cycle is similar to the one of an OdiKM. It begins when a user create one from an OdiProject using method OdiProject#addSKM(String), or when it is imported from external XML file. Life cycle ends when OdiSKM is removed from design time repository (i.e. IOdiEntityManager.remove()), or when enclosing OdiProject is removed from design time repository.
Since an instance of OdiSKM can be exported and imported. It implements the interface IExportable.
Field Summary |
---|
Fields inherited from class oracle.odi.domain.support.AbstractOdiEntity |
---|
STARTING_INTERNAL_VERSION |
Constructor Summary | |
---|---|
OdiSKM(OdiProject pProject, java.lang.String pName) Constructor that sets the parent project and the name of the KM |
Method Summary | |
---|---|
java.lang.String |
getCommandString() Get the command string for this SKM. |
java.lang.String |
getDescription() Returns the description of the SKM. |
java.io.Serializable |
getInternalId() Provides a common getter for the persistence layer to obtain an identity, irrespective of the actual type of identity used. |
java.lang.String |
getName() Gets the name of the SKM. |
OdiProject |
getProject() Returns the parent OdiProject . |
IRepositoryEntity |
getSecurityContainer() Define a generic way to retrieve container for entities. |
java.lang.Number |
getSKMId() Returns the SKMId value. |
void |
setCommandString(java.lang.String pCmd) Set the command string for this SKM. |
void |
setDescription(java.lang.String pDescription) Sets the description of the procedure. |
void |
setName(java.lang.String pName) Sets the name of the procedure. |
Methods inherited from class oracle.odi.domain.support.AbstractOdiEntity |
---|
equals, getFirstDate, getFirstUser, getInternalVersion, getLastDate, getLastUser, hashCode, isInstanceLevelSecurityNeeded, 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, isInstanceLevelSecurityNeeded |
Constructor Detail |
---|
public OdiSKM(OdiProject pProject, java.lang.String pName)
pProject
- the projectpName
- the skm namejava.lang.IllegalArgumentException
- if project is null or if name is null, empty or longer than NAME_MAX_LENGTH (400 characters)Method Detail |
---|
public java.lang.String getDescription()
setDescription(java.lang.String)
public void setDescription(java.lang.String pDescription)
pDescription
- a String representing the descriptiongetDescription()
public java.lang.String getName()
getName
in interface IOdiEntity
getName
in class oracle.odi.domain.support.AbstractOdiEntity
setName(java.lang.String)
public void setName(java.lang.String pName)
pName
- the skm namejava.lang.IllegalArgumentException
- if the given name is null/empty or is greater than 400 charactersgetName()
public OdiProject getProject()
OdiProject
.public java.lang.String getCommandString()
setCommandString(java.lang.String)
public void setCommandString(java.lang.String pCmd)
pCmd
- SKM commandgetCommandString()
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.lang.Number getSKMId()
public IRepositoryEntity getSecurityContainer()
IRepositoryEntity
getSecurityContainer
in interface IRepositoryEntity
|
Oracle® Data Integrator Java API Reference 11g Release 1 (11.1.1.5.0) E17060-02 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |