oracle.odi.domain.project
Class OdiSKM

java.lang.Object
  oracle.odi.domain.support.BusinessObject
      oracle.odi.domain.support.AbstractRepositoryEntity
          oracle.odi.domain.support.AbstractOdiEntity
              oracle.odi.domain.project.OdiSKM

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, IExportable, IOdiEntity, IRepositoryEntity, IWorkDevelopmentOdiEntity

public final class OdiSKM
extends oracle.odi.domain.support.AbstractOdiEntity
implements IWorkDevelopmentOdiEntity, IExportable

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.

Since:

11.1.1.3.0

See Also:

Serialized Form

Field Summary

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

STARTING_INTERNAL_VERSION

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

Method Detail

getCommandString

public java.lang.String getCommandString()

Get the command string for this SKM.

Returns:

command string (null if undefined)

See Also:

setCommandString(java.lang.String)

getDescription

public java.lang.String getDescription()

Returns the description of the SKM.

Returns:

a String representing the description

See Also:

setDescription(java.lang.String)

getInternalId

public java.io.Serializable getInternalId()

Description copied from interface: IRepositoryEntity

Provides a common getter for the persistence layer to obtain an identity, irrespective of the actual type of identity used.

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.

Specified by:

getInternalId in interface IRepositoryEntity

Returns:

the persistence identity of this instance

getName

public java.lang.String getName()

Gets the name of the SKM.

Specified by:

getName in interface IOdiEntity

Overrides:

getName in class oracle.odi.domain.support.AbstractOdiEntity

Returns:

the skm name

See Also:

setName(java.lang.String)

getProject

public OdiProject getProject()

Returns the parent OdiProject.

Returns:

a OdiProject representing the owning project

getSecurityContainer

public IRepositoryEntity getSecurityContainer()

Description copied from interface: IRepositoryEntity

Define a generic way to retrieve container for entities.

Specified by:

getSecurityContainer in interface IRepositoryEntity

Returns:

container entity

getSKMId

public java.lang.Number getSKMId()

Returns the SKMId value.

Returns:

a Number object representing the id of this SKM

setCommandString

public void setCommandString(java.lang.String pCmd)

Set the command string for this SKM.

Parameters:

pCmd - SKM command

See Also:

getCommandString()

setDescription

public void setDescription(java.lang.String pDescription)

Sets the description of the procedure.

Parameters:

pDescription - a String representing the description

See Also:

getDescription()

setName

public void setName(java.lang.String pName)

Sets the name of the procedure. Can't be null or empty.

Parameters:

pName - the skm name

Throws:

java.lang.IllegalArgumentException - if the given name is null/empty or is greater than 400 characters

See Also:

getName()