|
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.OdiProcedure<L>
public abstract class OdiProcedure<L extends OdiProcedureLine>
Abstract high-level object encompassing ODI User Procedures and ODI Knowledge Modules.
OdiProcedure is an abstract class that doesn't represent any actual ODI concept. However, it manages commons requirements, of both OdiUserProcedure and OdiKM (and its subclasses). As such, it provides getter and setter methods for commons properties like name and description. It also provides the notion of defaultTargetTechnology and defaultSourceTechnology, as well as a multiConnectionSupported indicator telling whether the OdiProcedure instance is able to deal with a target DataServer and a source DataServer, or not. Those properties are used during ODI Interface design to assist users by giving it a choice between most appropriates KMs.
An OdiProcedure also provides methods to manage OdiProcedureLines and ProcedureOptions. OdiProcedure is the root entity of the OdiProcedure - OdiProcedureLine - OdiProcedureLineCmd - ProcedureOption aggregate. Thus an instance of OdiProcedure controls life cycle of every instances from this aggregate that belongs to it and provides auditing information about this aggregate. As such, it implements the IOdiEntity interface.
An OdiProcedure has an ID that can be obtained from getProcedureId() method call. This ID is assigned when an OdiProcedure is stored into design time repository. This ID represents the identity of an OdiProcedure. Equals / hashCode method are implemented according this identity.
An OdiProcedure life cycle begins when a user create a concrete implementation such as OdiUserProcedure or OdiKM. It is then typically stored inside ODI design time repository. The users can modify it in order to make it fit their needs. Life cycle ends when a user deletes the concrete implementation from design time repository (i.e. using IOdiEntityManager.remove ()).
OdiKM
, OdiUserProcedure
, Serialized FormField Summary | |
---|---|
static int |
NAME_MAX_LENGTH Maximum length of an Odi Procedure's name. |
Fields inherited from class oracle.odi.domain.support.AbstractOdiEntity |
---|
STARTING_INTERNAL_VERSION |
Method Summary | |
---|---|
L |
addLine(java.lang.String pName) Adds (assigning it the latest position) a new OdiProcedureLine with the given name and default properties. |
L |
addLine(java.lang.String pName, OdiProcedureLineCmd pTargetCommand, OdiProcedureLineCmd pSourceCommand, java.util.Collection<ProcedureOption> pGenerationConditions) Adds (assigning it the latest position) a new OdiProcedureLine with the given name, the given target and source commands (possibly nulls) and options (possibly null) that will condition the generation of the line. |
ProcedureOption |
addOption(java.lang.String pOptionName) Adds (assigning it the lastest position) a new ProcedureOption with the given name and default OptionType to this OdiProcedure. |
ProcedureOption |
addOption(java.lang.String pOptionName, ProcedureOption.OptionType pType, java.lang.Object pDefaultValue) Adds (assigning it the lastest position) a new ProcedureOption of the given type, default value and with the given name to this OdiProcedure. |
OdiTechnology |
getDefaultSourceTechnology() Gets the default source technology of this OdiProcedure. |
OdiTechnology |
getDefaultTargetTechnology() Gets the default target technology of this OdiProcedure. |
java.lang.String |
getDescription() Returns the description of the procedure. |
java.util.Collection<IFlexFieldValue> |
getFlexFieldsValues() Obtains flex fields values related to this IFlexFieldUser . |
java.io.Serializable |
getInternalId() Return the internal id of the procedure. |
java.util.List<L> |
getLines() Returns an unmodifiable list of OdiProcedureLines held by this OdiProcedure. |
java.lang.String |
getName() Returns the name of the procedure. |
ProcedureOption |
getOption(java.lang.String pName) Retrieves the procedure option which name is the parameter name. |
java.util.Collection<java.lang.String> |
getOptionNames() Returns a collection of names of all this procedure's options. |
java.util.List<ProcedureOption> |
getOptions() Returns an unmodifable list of ProcedureOptions held by this OdiProcedure. |
java.lang.Number |
getProcedureId() Return the procedure identifier. |
IRepositoryEntity |
getSecurityContainer() Define a generic way to retrieve container for entities. |
void |
initFlexFields(IOdiFlexFieldFinder pOdiFlexFieldFinder) Initialize flex fields related to this IFlexFieldUser . |
boolean |
isMultiConnectionSupported() Return whether this OdiProcedure supports mulitConnection or not. |
void |
moveLineAfter(L pSource, L pAfter) Moves the given OdiProcedureLine after the line specified. |
void |
moveLineBefore(L pSource, L pBefore) Moves the given Procedure Moves the given OdiProcedureLine before the line specified. |
void |
removeLine(L pLine) Removes the given line from this OdiProcedure. |
void |
removeOption(ProcedureOption pOption) Remove the specified option from this procedure. |
void |
setDefaultSourceTechnology(OdiTechnology pTechnology) Sets the default source technology of this OdiProcedure. |
void |
setDefaultTargetTechnology(OdiTechnology pTechnology) Sets the default target technology. |
void |
setDescription(java.lang.String pDescription) Sets the description of the procedure. |
void |
setMultiConnectionSupported(boolean pMultiConnectionSupported) Defines whether this OdiProcedure supports mulitConnection or not. |
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 |
Field Detail |
---|
public static final int NAME_MAX_LENGTH
Method Detail |
---|
public java.io.Serializable getInternalId()
getInternalId
in interface IRepositoryEntity
getProcedureId()
public java.lang.String getName()
getName
in interface IOdiEntity
getName
in class oracle.odi.domain.support.AbstractOdiEntity
setName(String)
public java.lang.String getDescription()
setDescription(String)
public void setDescription(java.lang.String pDescription)
pDescription
- the descriptiongetDescription()
public void setName(java.lang.String pName)
pName
- the procedure namejava.lang.IllegalArgumentException
- if the name is invalid.getName()
public ProcedureOption getOption(java.lang.String pName)
pName
- the name of the optionaddOption(ProcedureOption)
public java.util.Collection<java.lang.String> getOptionNames()
getOptions()
, getOption(String)
public java.util.List<ProcedureOption> getOptions()
The obtained list is ordered by option's positions.
Note that list's indexes and options positions are consistent by not equals since the position of a ProcedureOption can be changed manually from ProcedureOption#setPosition(int). Also, when a ProcedureOption's position is changed, the obtained list is not consistent anymore with the new position.
addOption(ProcedureOption)
, getOption(String)
public final ProcedureOption addOption(java.lang.String pOptionName)
pOptionName
- option namejava.lang.IllegalArgumentException
- if name is null or empty or if option already existspublic final ProcedureOption addOption(java.lang.String pOptionName, ProcedureOption.OptionType pType, java.lang.Object pDefaultValue)
pOptionName
- Name of option.pType
- Option typepDefaultValue
- Default valuepublic void removeOption(ProcedureOption pOption)
The option is also removed from any OdiProcedureLine's generation condition.
pOption
- the option to removejava.lang.IllegalArgumentException
- if the parameter is null or not associated to this procedure.public OdiTechnology getDefaultSourceTechnology()
java.lang.IllegalStateException
- if multi connections are not supportedsetDefaultSourceTechnology(oracle.odi.domain.topology.OdiTechnology)
public void setDefaultSourceTechnology(OdiTechnology pTechnology)
Mainly used inside ODI Studio when creating commands.
By default this property is set to null
.
pTechnology
- the default source technologyjava.lang.IllegalStateException
- if multi connections are not supportedgetDefaultSourceTechnology()
public OdiTechnology getDefaultTargetTechnology()
setDefaultTargetTechnology(oracle.odi.domain.topology.OdiTechnology)
public void setDefaultTargetTechnology(OdiTechnology pTechnology)
Mainly used inside ODI Studio when creating commands.
By default this property is set to null
.
pTechnology
- the default target technologygetDefaultTargetTechnology()
public final L addLine(java.lang.String pName)
pName
- Name of line.java.lang.IllegalArgumentException
- if the parameter is null or empty.public final L addLine(java.lang.String pName, OdiProcedureLineCmd pTargetCommand, OdiProcedureLineCmd pSourceCommand, java.util.Collection<ProcedureOption> pGenerationConditions)
pName
- Name of line.pTargetCommand
- target command, or nullpSourceCommand
- source command, or nullpGenerationConditions
- conditions, or nulljava.lang.IllegalArgumentException
- if the name is null or empty.public java.util.List<L> getLines()
public void moveLineAfter(L pSource, L pAfter)
pSource
- source linepAfter
- move source line after this linejava.lang.IllegalArgumentException
- if source or after do not belong to this OdiProcedurepublic void moveLineBefore(L pSource, L pBefore)
pSource
- source linepBefore
- move source line before this linejava.lang.IllegalArgumentException
- if source or after do not belong to this OdiProcedurepublic void removeLine(L pLine)
pLine
- line to be removedjava.lang.IllegalArgumentException
- if the given line is null or does not belong to this OdiProcedure.public void setMultiConnectionSupported(boolean pMultiConnectionSupported)
Setting this will affect source technology. If set to false, source technology will be set to null.
pMultiConnectionSupported
- true
to make this procedure supports mutliConnection, false
otherwiseisMultiConnectionSupported()
public boolean isMultiConnectionSupported()
true
if the procedure supports mutliConnection, false
otherwisesetMultiConnectionSupported(boolean)
public java.lang.Number getProcedureId()
public IRepositoryEntity getSecurityContainer()
IRepositoryEntity
getSecurityContainer
in interface IRepositoryEntity
public java.util.Collection<IFlexFieldValue> getFlexFieldsValues()
IFlexFieldUser
IFlexFieldUser
.getFlexFieldsValues
in interface IFlexFieldUser
public void initFlexFields(IOdiFlexFieldFinder pOdiFlexFieldFinder)
IFlexFieldUser
IFlexFieldUser
.initFlexFields
in interface IFlexFieldUser
pOdiFlexFieldFinder
- OdiFlexField
finder to be used to query flex fields
|
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 |