|
Oracle® Data Integrator Java API Reference 11g Release 1 (11.1.1.6.0) E17060-03 |
|||||||||
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<OdiUserProcedureLine>
oracle.odi.domain.project.OdiUserProcedure
public final class OdiUserProcedure
Represents the ODI user procedures.
An OdiUserProcedure is a set of commands that can be executed by an agent. These commands concern all technologies accessible by Oracle Data Integrator (OS, JDBC, JMS commands, etc).
If an OdiUserProcedure is constructed with a reference object, the OdiUserProcedure will represented a shortcut to the reference object. When an OdiUserProcedure is used as a shortcut, most properties are accessed through the base object. The IOdiShortcutable
interface implemented by OdiInterface provides access and control over the shortcut aspects of this object.
Instances of OdiUserProcedure follow same life cycle as defined in OdiProcedure class with the following additions:
An OdiUserProcedure is dedicated to a single OdiProject and is located inside an OdiFolder. Thus, life cycle of an OdiUserProcedure begin when it is created from an OdiFolder using OdiFolder#addUserProcedure(String name) method, or when an OdiUserProcedure is imported from an XML file.
Life cycle ends when enclosing OdiProject or OdiFolder is removed from design time repository. An instance of OdiUserProcedure can be generated into an OdiScenario and implements the interface IOdiScenarioSource for this purpose. Also, an instance of OdiUserProcedure can be exported and imported. It implements the interface IExportable.
OdiUserProcedureClass class is defined to only use OdiUserProcedureLineLine as ProcedureLine.
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 |
Constructor Summary | |
---|---|
OdiUserProcedure(OdiFolder pFolder, java.lang.String pName) Constructor that sets the parent OdiFolder and the name of this OdiUserProcedure instance. |
|
OdiUserProcedure(OdiFolder pFolder, java.lang.String pName, OdiUserProcedure pReferenceUserProcedure) Constructor that sets the parentFolder, the name of the user procedure, and the reference user procedure. |
Method Summary | |
---|---|
OdiUserProcedureLine |
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. |
java.util.Collection<IOptionValue> |
getExecutionOptions() Obtains an unmodifiable collection of options defined for the design time execution of this OdiUserProcedure. |
OdiFolder |
getFolder() Return the parent OdiFolder . |
java.lang.Number |
getInstanceId() |
java.util.List<OdiUserProcedureLine> |
getLines() Returns an unmodifiable list of OdiProcedureLines held by this OdiProcedure. |
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. |
OdiUserProcedure |
getRealObject() Return the real object associated with this object. |
IReleaseTag |
getReleaseTag() Return the release tag for this object. |
IRepositoryEntity |
getSecurityContainer() Define a generic way to retrieve container for entities. |
OdiUserProcedure |
getShortcutBaseObject() Return the base object of this shortcutable. |
OdiUserProcedure |
getShortcutOrigObject() If this is a shortcut, return the original base object |
OdiUserProcedure |
getShortcutReferenceObject() If this is a shortcut, return the reference object. |
boolean |
isInstanceLevelSecurityNeeded() Internal: this method is for internal purpose and must not be considered as part of the public API. |
boolean |
isMultiConnectionSupported() Return whether this OdiProcedure supports mulitConnection or not. |
boolean |
isShortcut() Returns true if this object is a shortcut. |
void |
moveLineAfter(OdiUserProcedureLine pSource, OdiUserProcedureLine pAfter) Moves the given OdiProcedureLine after the line specified. |
void |
moveLineBefore(OdiUserProcedureLine pSource, OdiUserProcedureLine pBefore) Moves the given Procedure Moves the given OdiProcedureLine before the line specified. |
void |
removeLine(OdiUserProcedureLine 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 |
setMultiConnectionSupported(boolean pMultiConnectionSupported) Defines whether this OdiProcedure supports mulitConnection or not. |
boolean |
setShortcutBaseObject(OdiUserProcedure pBaseObject) Internal Use Only. |
boolean |
setShortcutReferenceObject(OdiUserProcedure pReferenceObject) Internal Use Only. |
Methods inherited from class oracle.odi.domain.project.OdiProcedure |
---|
addLine, getDefaultSourceTechnology, getDefaultTargetTechnology, getDescription, getFlexFieldsValues, getInternalId, getName, getProcedureId, initFlexFields, setDescription, 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 |
Constructor Detail |
---|
public OdiUserProcedure(OdiFolder pFolder, java.lang.String pName, OdiUserProcedure pReferenceUserProcedure)
pFolder
- owning folderpName
- name of OdiUserProcedurepReferenceUserProcedure
- The reference datastore for this datastore shortcut.DomainRuntimeException
- if the folder is null or if the name is null, empty or longer than NAME_MAX_LENGTH (400 characters)OdiFolder
public OdiUserProcedure(OdiFolder pFolder, java.lang.String pName)
OdiFolder
and the name of this OdiUserProcedure
instance.
pFolder
- owning folderpName
- name of OdiUserProcedureDomainRuntimeException
- if the folder is null or if the name is null, empty or longer than NAME_MAX_LENGTH (400 characters)OdiFolder
Method Detail |
---|
public IRepositoryEntity getSecurityContainer()
IRepositoryEntity
getSecurityContainer
in interface IRepositoryEntity
getSecurityContainer
in class OdiProcedure<OdiUserProcedureLine>
public OdiFolder getFolder()
OdiFolder
.OdiFolder
OdiFolder
, setFolder(OdiFolder)
public boolean isInstanceLevelSecurityNeeded()
IOdiEntity
Defines a method to capture the info on which object needs instance level privilege.
isInstanceLevelSecurityNeeded
in interface IOdiEntity
isInstanceLevelSecurityNeeded
in class oracle.odi.domain.support.AbstractOdiEntity
true
if instance level security needed, false
otherwisepublic java.util.Collection<IOptionValue> getExecutionOptions()
java.lang.IllegalStateException
- if this is a shortcut. Use getRealObject to access.public java.lang.Number getInstanceId()
getInstanceId
in interface oracle.odi.domain.procusage.IProcedureUser
public OdiUserProcedure getShortcutBaseObject()
IOdiShortcutable
This will return null if the object never has been a shortcut. If this object is a materialized shortcut, the base object will be the base object at the time that this was shortcuted.
getShortcutBaseObject
in interface IOdiShortcutable<OdiUserProcedure>
public boolean setShortcutBaseObject(OdiUserProcedure pBaseObject)
IOdiShortcutable
If the base object is changed, we should correct all consumers of this object.
This method may be called from a precedent shortcut object in the shortcut chain and the precedent shortcut obejct is removed or materialized.
setShortcutBaseObject
in interface IOdiShortcutable<OdiUserProcedure>
pBaseObject
- new base object.public OdiUserProcedure getShortcutReferenceObject()
IOdiShortcutable
The reference object may also be a shortcut.
getShortcutReferenceObject
in interface IOdiShortcutable<OdiUserProcedure>
public boolean setShortcutReferenceObject(OdiUserProcedure pReferenceObject)
IOdiShortcutable
If pShortcutable is null, set pReference to null. This is no longer a shortcut.
If pShortcutable is not null, set the reference object to pShortcutable, set the base object to pShortcutable.getBaseObject.
This method may be called from a precedent shortcut object in the shortcut chain and the precedent shortcut obejct is removed or materialized.
setShortcutReferenceObject
in interface IOdiShortcutable<OdiUserProcedure>
pReferenceObject
- new shortcutable object. Can be be nullpublic OdiUserProcedure getShortcutOrigObject()
IOdiShortcutable
The reference object may also be a shortcut.
getShortcutOrigObject
in interface IOdiShortcutable<OdiUserProcedure>
public IReleaseTag getReleaseTag()
IOdiShortcutable
release tag is actually maintained on the container object. This provides consistent access to the tag.
getReleaseTag
in interface IOdiShortcutable<OdiUserProcedure>
public boolean isShortcut()
IOdiShortcutable
isShortcut
in interface IOdiShortcutable<OdiUserProcedure>
public OdiUserProcedure getRealObject()
IOdiShortcutable
This is a convenience function to obtain the real object of a shortcutable object. If this object is a shortcut, return the base obejct. If this object is not a shortcut, return this object.
getRealObject
in interface IOdiShortcutable<OdiUserProcedure>
public ProcedureOption getOption(java.lang.String pName)
OdiProcedure
getOption
in class OdiProcedure<OdiUserProcedureLine>
pName
- the name of the optionjava.lang.IllegalStateException
- if this is a shortcut. Use getRealObject to access.OdiProcedure.addOption(ProcedureOption)
public java.util.Collection<java.lang.String> getOptionNames()
OdiProcedure
getOptionNames
in class OdiProcedure<OdiUserProcedureLine>
java.lang.IllegalStateException
- if this is a shortcut. Use getRealObject to access.OdiProcedure.getOptions()
, OdiProcedure.getOption(String)
public java.util.List<ProcedureOption> getOptions()
OdiProcedure
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.
getOptions
in class OdiProcedure<OdiUserProcedureLine>
java.lang.IllegalStateException
- if this is a shortcut. Use getRealObject to access.OdiProcedure.addOption(ProcedureOption)
, OdiProcedure.getOption(String)
public ProcedureOption addOption(java.lang.String pOptionName)
OdiProcedure
addOption
in class OdiProcedure<OdiUserProcedureLine>
pOptionName
- option namejava.lang.IllegalStateException
- if this is a shortcut. Use getRealObject to access.public ProcedureOption addOption(java.lang.String pOptionName, ProcedureOption.OptionType pType, java.lang.Object pDefaultValue)
OdiProcedure
addOption
in class OdiProcedure<OdiUserProcedureLine>
pOptionName
- Name of option.pType
- Option typepDefaultValue
- Default valuejava.lang.IllegalStateException
- if this is a shortcut. Use getRealObject to access.public void removeOption(ProcedureOption pOption)
OdiProcedure
The option is also removed from any OdiProcedureLine's generation condition.
removeOption
in class OdiProcedure<OdiUserProcedureLine>
pOption
- the option to removejava.lang.IllegalStateException
- if this is a shortcut. Use getRealObject to access.public void setDefaultSourceTechnology(OdiTechnology pTechnology)
OdiProcedure
Mainly used inside ODI Studio when creating commands.
By default this property is set to null
.
setDefaultSourceTechnology
in class OdiProcedure<OdiUserProcedureLine>
pTechnology
- the default source technologyjava.lang.IllegalStateException
- if this is a shortcut. Use getRealObject to access.OdiProcedure.getDefaultSourceTechnology()
public void setDefaultTargetTechnology(OdiTechnology pTechnology)
OdiProcedure
Mainly used inside ODI Studio when creating commands.
By default this property is set to null
.
setDefaultTargetTechnology
in class OdiProcedure<OdiUserProcedureLine>
pTechnology
- the default target technologyjava.lang.IllegalStateException
- if this is a shortcut. Use getRealObject to access.OdiProcedure.getDefaultTargetTechnology()
public OdiUserProcedureLine addLine(java.lang.String pName, OdiProcedureLineCmd pTargetCommand, OdiProcedureLineCmd pSourceCommand, java.util.Collection<ProcedureOption> pGenerationConditions)
OdiProcedure
addLine
in class OdiProcedure<OdiUserProcedureLine>
pName
- Name of line.pTargetCommand
- target command, or nullpSourceCommand
- source command, or nullpGenerationConditions
- conditions, or nulljava.lang.IllegalStateException
- if this is a shortcut. Use getRealObject to access.public java.util.List<OdiUserProcedureLine> getLines()
OdiProcedure
getLines
in class OdiProcedure<OdiUserProcedureLine>
java.lang.IllegalStateException
- if this is a shortcut. Use getRealObject to access.public void moveLineAfter(OdiUserProcedureLine pSource, OdiUserProcedureLine pAfter)
OdiProcedure
moveLineAfter
in class OdiProcedure<OdiUserProcedureLine>
pSource
- source linepAfter
- move source line after this linejava.lang.IllegalStateException
- if this is a shortcut. Use getRealObject to access.public void moveLineBefore(OdiUserProcedureLine pSource, OdiUserProcedureLine pBefore)
OdiProcedure
moveLineBefore
in class OdiProcedure<OdiUserProcedureLine>
pSource
- source linepBefore
- move source line before this linejava.lang.IllegalStateException
- if this is a shortcut. Use getRealObject to access.public void removeLine(OdiUserProcedureLine pLine)
OdiProcedure
removeLine
in class OdiProcedure<OdiUserProcedureLine>
pLine
- line to be removedjava.lang.IllegalStateException
- if this is a shortcut. Use getRealObject to access.public void setMultiConnectionSupported(boolean pMultiConnectionSupported)
OdiProcedure
Setting this will affect source technology. If set to false, source technology will be set to null.
setMultiConnectionSupported
in class OdiProcedure<OdiUserProcedureLine>
pMultiConnectionSupported
- true
to make this procedure supports mutliConnection, false
otherwisejava.lang.IllegalStateException
- if this is a shortcut. Use getRealObject to access.OdiProcedure.isMultiConnectionSupported()
public boolean isMultiConnectionSupported()
OdiProcedure
isMultiConnectionSupported
in class OdiProcedure<OdiUserProcedureLine>
true
if the procedure supports mutliConnection, false
otherwisejava.lang.IllegalStateException
- if this is a shortcut. Use getRealObject to access.OdiProcedure.setMultiConnectionSupported(boolean)
|
Oracle® Data Integrator Java API Reference 11g Release 1 (11.1.1.6.0) E17060-03 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |