oracle.odi.domain.project

Class OdiUserProcedure

java.lang.Object

oracle.odi.domain.support.BusinessObject

oracle.odi.domain.support.AbstractRepositoryEntity

oracle.odi.domain.support.AbstractOdiEntity

oracle.odi.domain.project.OdiProcedure

oracle.odi.domain.project.OdiUserProcedure

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, oracle.odi.core.audit.support.IAuditableFirstClassObject, IFlexFieldUser, IModelObject, IModelObjectBase, IProcedure, IProcedureUser, oracle.odi.domain.impexp.IExportable, IOdiEntity, IRepositoryEntity, IWorkDevelopmentOdiEntity, IOdiScenarioSource, oracle.odi.domain.shortcuts.IOdiShortcutable, oracle.odi.impexp.smartie.ISmartExportable

public final class OdiUserProcedure
extends OdiProcedure
implements oracle.odi.domain.shortcuts.IOdiShortcutable, IOdiScenarioSource, oracle.odi.domain.impexp.IExportable, IProcedureUser, oracle.odi.impexp.smartie.ISmartExportable, oracle.odi.core.audit.support.IAuditableFirstClassObject

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.

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

Constructor Summary

Constructors

Constructor and Description
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

Modifier and Type	Method and Description
OdiUserProcedureLine	addLine(java.lang.String pName, OdiProcedureLineCmd pTargetCommand, OdiProcedureLineCmd pSourceCommand, java.util.Collection 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.
boolean	changeShortcutReferenceObject(OdiUserProcedure pReferenceObject)
void	checkValidReference(OdiUserProcedure pReferenceObject)
OdiDesigntimeBreakpoint	getBreakpointOn(OdiUserProcedureLine pUserProcedureLine) Returns breakpoint set on the line specified if any and null otherwise.
java.util.Collection	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() Return the internal identifier of the instance that is marked by this interface.
java.util.List	getLines() Returns an unmodifiable list of OdiProcedureLines held by this OdiProcedure.
java.lang.Class	getLineType()
ProcedureOption	getOption(java.lang.String pName) Retrieves the procedure option which name is the parameter name.
java.util.Collection	getOptionNames() Returns a collection of names of all this procedure's options.
java.util.List	getOptions() Returns an unmodifable list of ProcedureOptions held by this OdiProcedure.
OdiUserProcedure	getRealObject()
IReleaseTag	getReleaseTag()
OdiUserProcedure	getShortcutBaseObject()
OdiUserProcedure	getShortcutOrigObject() Deprecated.
OdiUserProcedure	getShortcutReferenceObject()
boolean	isCleanupOnError() Returns true if cleanup tasks should be performed on error, false otherwise.
boolean	isConcurrent() Returns true if concurrency enabled, false otherwise.
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()
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	removeBreakpointOn(OdiUserProcedureLine pUserProcedureLine) Removes breakpoint on 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.
OdiDesigntimeBreakpoint	setBreakpointOn(OdiUserProcedureLine pUserProcedureLine) Sets breakpoint on the line specified.
void	setCleanupOnError(boolean pCleanupOnError) Cleanup tasks should be performed on error is pCleanupOnError is true.
void	setConcurrent(boolean pConcurrent) Enables concurrency if pConcurrent is true and disables it otherwise.
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)
boolean	setShortcutReferenceObject(OdiUserProcedure pReferenceObject)

Methods inherited from class oracle.odi.domain.project.OdiProcedure

addLine, addLine, addLine, addOptionGroup, addProcedureLine, addProcedureLine, addProcedureOption, dumpLineOrder, duplicateLine, duplicateOption, getDefaultSourceTechnology, getDefaultTargetTechnology, getDescription, getFlexFieldsValues, getInternalId, getName, getOptionGroup, getOptionGroups, getOptionsWithNoGroup, getProcedureId, getProcedureOption, getProcedureOptions, getTopLevelLines, initFlexFields, isProcedureLine, moveGroupAfterGroup, moveGroupBeforeGroup, moveLineToBottom, moveLineToTop, moveOptionAfter, moveOptionBefore, moveOptionToBottom, moveOptionToTop, removeOptionGroup, removeProcedureLine, setDescription, setName

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

getFirstDate, getFirstUser, getInternalVersion, getLastDate, getLastUser, isNew, preCommit, toString

Methods inherited from class oracle.odi.domain.support.AbstractRepositoryEntity

equals, getBigNumericId, getGlobalId, getNumericId, getParent, hashCode

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.adapter.IModelObjectBase

getBigNumericId, getGlobalId, getNumericId

Methods inherited from interface oracle.odi.domain.IOdiEntity

getFirstDate, getFirstUser, getLastDate, getLastUser

Methods inherited from interface oracle.odi.domain.IRepositoryEntity

getGlobalId, getParent

Constructor Detail

OdiUserProcedure

public 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. If pReferenceUserProcedure is not null, this object will is a user procedure shortcut.

Parameters:

pFolder - owning folder

pName - name of OdiUserProcedure

pReferenceUserProcedure - The reference datastore for this datastore shortcut.

Throws:

DomainRuntimeException - if the folder is null or if the name is null, empty or longer than NAME_MAX_LENGTH (400 characters)

See Also:

OdiFolder

OdiUserProcedure

public OdiUserProcedure(OdiFolder pFolder,
                        java.lang.String pName)

Constructor that sets the parent OdiFolder and the name of this OdiUserProcedure instance.

Parameters:

pFolder - owning folder

pName - name of OdiUserProcedure

Throws:

DomainRuntimeException - if the folder is null or if the name is null, empty or longer than NAME_MAX_LENGTH (400 characters)

See Also:

OdiFolder

Method Detail

getFolder

public OdiFolder getFolder()

Return the parent OdiFolder.

Returns:

OdiFolder

See Also:

OdiFolder, setFolder(OdiFolder)

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

getExecutionOptions

public java.util.Collection getExecutionOptions()

Obtains an unmodifiable collection of options defined for the design time execution of this OdiUserProcedure.

Returns:

a Collection object representing the execution options value

Throws:

java.lang.IllegalStateException - if this is a shortcut. Use getRealObject to access.

getInstanceId

public java.lang.Number getInstanceId()

Description copied from interface: IProcedureUser

Return the internal identifier of the instance that is marked by this interface. (e.g. OdiModel implementation of that method return the modelId).

Specified by:

getInstanceId in interface IProcedureUser

Returns:

the ODI instance id.

getShortcutBaseObject

public OdiUserProcedure getShortcutBaseObject()

Specified by:

getShortcutBaseObject in interface oracle.odi.domain.shortcuts.IOdiShortcutable

setShortcutBaseObject

public boolean setShortcutBaseObject(OdiUserProcedure pBaseObject)

Specified by:

setShortcutBaseObject in interface oracle.odi.domain.shortcuts.IOdiShortcutable

getShortcutReferenceObject

public OdiUserProcedure getShortcutReferenceObject()

Specified by:

getShortcutReferenceObject in interface oracle.odi.domain.shortcuts.IOdiShortcutable

setShortcutReferenceObject

public boolean setShortcutReferenceObject(OdiUserProcedure pReferenceObject)

Specified by:

setShortcutReferenceObject in interface oracle.odi.domain.shortcuts.IOdiShortcutable

getShortcutOrigObject

public OdiUserProcedure getShortcutOrigObject()

Deprecated.

Specified by:

getShortcutOrigObject in interface oracle.odi.domain.shortcuts.IOdiShortcutable

getReleaseTag

public IReleaseTag getReleaseTag()

Specified by:

getReleaseTag in interface oracle.odi.domain.shortcuts.IOdiShortcutable

isShortcut

public boolean isShortcut()

Specified by:

isShortcut in interface oracle.odi.domain.shortcuts.IOdiShortcutable

getRealObject

public OdiUserProcedure getRealObject()

Specified by:

getRealObject in interface oracle.odi.domain.shortcuts.IOdiShortcutable

checkValidReference

public void checkValidReference(OdiUserProcedure pReferenceObject)

Specified by:

checkValidReference in interface oracle.odi.domain.shortcuts.IOdiShortcutable

changeShortcutReferenceObject

public boolean changeShortcutReferenceObject(OdiUserProcedure pReferenceObject)

Specified by:

changeShortcutReferenceObject in interface oracle.odi.domain.shortcuts.IOdiShortcutable

getOption

public ProcedureOption getOption(java.lang.String pName)

Description copied from class: OdiProcedure

Retrieves the procedure option which name is the parameter name.

Overrides:

getOption in class OdiProcedure

Parameters:

pName - the name of the option

Returns:

the ProcedureOption matching the given name

Throws:

java.lang.IllegalStateException - if this is a shortcut. Use getRealObject to access.

See Also:

OdiProcedure.addOption(ProcedureOption)

getOptionNames

public java.util.Collection getOptionNames()

Description copied from class: OdiProcedure

Returns a collection of names of all this procedure's options.

Overrides:

getOptionNames in class OdiProcedure

Returns:

a Collection object representing the option names

Throws:

java.lang.IllegalStateException - if this is a shortcut. Use getRealObject to access.

See Also:

OdiProcedure.getOptions(), OdiProcedure.getOption(String)

getOptions

public java.util.List getOptions()

Description copied from class: OdiProcedure

Returns an unmodifable list of ProcedureOptions held by this 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.

Overrides:

getOptions in class OdiProcedure

Returns:

List of ProcedureOption

Throws:

java.lang.IllegalStateException - if this is a shortcut. Use getRealObject to access.

See Also:

OdiProcedure.addOption(ProcedureOption), OdiProcedure.getOption(String)

addOption

public ProcedureOption addOption(java.lang.String pOptionName)

Description copied from class: OdiProcedure

Adds (assigning it the lastest position) a new ProcedureOption with the given name and default OptionType to this OdiProcedure.

Overrides:

addOption in class OdiProcedure

Parameters:

pOptionName - option name

Returns:

the newly created ProcedureOption.

Throws:

java.lang.IllegalStateException - if this is a shortcut. Use getRealObject to access.

addOption

public ProcedureOption addOption(java.lang.String pOptionName,
                                 ProcedureOption.OptionType pType,
                                 java.lang.Object pDefaultValue)

Description copied from class: OdiProcedure

Adds (assigning it the lastest position) a new ProcedureOption of the given type, default value and with the given name to this OdiProcedure.

Overrides:

addOption in class OdiProcedure

Parameters:

pOptionName - Name of option.

pType - Option type

pDefaultValue - Default value

Returns:

the newly created ProcedureOption.

Throws:

java.lang.IllegalStateException - if this is a shortcut. Use getRealObject to access.

removeOption

public void removeOption(ProcedureOption pOption)

Description copied from class: OdiProcedure

Remove the specified option from this procedure.

The option is also removed from any OdiProcedureLine's generation condition.

Overrides:

removeOption in class OdiProcedure

Parameters:

pOption - the option to remove

Throws:

java.lang.IllegalStateException - if this is a shortcut. Use getRealObject to access.

setDefaultSourceTechnology

public void setDefaultSourceTechnology(OdiTechnology pTechnology)

Description copied from class: OdiProcedure

Sets the default source technology of this OdiProcedure.

Mainly used inside ODI Studio when creating commands.

By default this property is set to null.

Overrides:

setDefaultSourceTechnology in class OdiProcedure

Parameters:

pTechnology - the default source technology

Throws:

java.lang.IllegalStateException - if this is a shortcut. Use getRealObject to access.

See Also:

OdiProcedure.getDefaultSourceTechnology()

setDefaultTargetTechnology

public void setDefaultTargetTechnology(OdiTechnology pTechnology)

Description copied from class: OdiProcedure

Sets the default target technology.

Mainly used inside ODI Studio when creating commands.

By default this property is set to null.

Overrides:

setDefaultTargetTechnology in class OdiProcedure

Parameters:

pTechnology - the default target technology

Throws:

java.lang.IllegalStateException - if this is a shortcut. Use getRealObject to access.

See Also:

OdiProcedure.getDefaultTargetTechnology()

addLine

public OdiUserProcedureLine addLine(java.lang.String pName,
                                    OdiProcedureLineCmd pTargetCommand,
                                    OdiProcedureLineCmd pSourceCommand,
                                    java.util.Collection pGenerationConditions)

Description copied from class: OdiProcedure

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. Other OdiProcedureLine properties are made default.

Overrides:

addLine in class OdiProcedure

Parameters:

pName - Name of line.

pTargetCommand - target command, or null

pSourceCommand - source command, or null

pGenerationConditions - conditions, or null

Returns:

the newly created OdiProcedureLine

Throws:

java.lang.IllegalStateException - if this is a shortcut. Use getRealObject to access.

getLines

public java.util.List getLines()

Description copied from class: OdiProcedure

Returns an unmodifiable list of OdiProcedureLines held by this OdiProcedure. The obtained list is ordered according to the execution / generation order.

Overrides:

getLines in class OdiProcedure

Returns:

List of lines.

Throws:

java.lang.IllegalStateException - if this is a shortcut. Use getRealObject to access.

moveLineAfter

public void moveLineAfter(OdiUserProcedureLine pSource,
                          OdiUserProcedureLine pAfter)

Description copied from class: OdiProcedure

Moves the given OdiProcedureLine after the line specified. This will internally rearrange OdiProcedureLines accordingly.

Overrides:

moveLineAfter in class OdiProcedure

Parameters:

pSource - source line

pAfter - move source line after this line

Throws:

java.lang.IllegalStateException - if this is a shortcut. Use getRealObject to access.

moveLineBefore

public void moveLineBefore(OdiUserProcedureLine pSource,
                           OdiUserProcedureLine pBefore)

Description copied from class: OdiProcedure

Moves the given Procedure Moves the given OdiProcedureLine before the line specified. This will internally rearrange OdiProcedureLines accordingly.

Overrides:

moveLineBefore in class OdiProcedure

Parameters:

pSource - source line

pBefore - move source line before this line

Throws:

java.lang.IllegalStateException - if this is a shortcut. Use getRealObject to access.

removeLine

public void removeLine(OdiUserProcedureLine pLine)

Description copied from class: OdiProcedure

Removes the given line from this OdiProcedure.

Overrides:

removeLine in class OdiProcedure

Parameters:

pLine - line to be removed

Throws:

java.lang.IllegalStateException - if this is a shortcut. Use getRealObject to access.

setMultiConnectionSupported

public void setMultiConnectionSupported(boolean pMultiConnectionSupported)

Description copied from class: OdiProcedure

Defines whether this OdiProcedure supports mulitConnection or not. Mainly used by ODI Studio to determine best-suited procedures.

Setting this will affect source technology. If set to false, source technology will be set to null.

Overrides:

setMultiConnectionSupported in class OdiProcedure

Parameters:

pMultiConnectionSupported - true to make this procedure supports mutliConnection, false otherwise

Throws:

java.lang.IllegalStateException - if this is a shortcut. Use getRealObject to access.

See Also:

OdiProcedure.isMultiConnectionSupported()

isMultiConnectionSupported

public boolean isMultiConnectionSupported()

Description copied from class: OdiProcedure

Return whether this OdiProcedure supports mulitConnection or not. Mainly used by ODI Studio to determine best-suited procedures

Overrides:

isMultiConnectionSupported in class OdiProcedure

Returns:

true if the procedure supports mutliConnection, false otherwise

Throws:

java.lang.IllegalStateException - if this is a shortcut. Use getRealObject to access.

See Also:

OdiProcedure.setMultiConnectionSupported(boolean)

setBreakpointOn

public OdiDesigntimeBreakpoint setBreakpointOn(OdiUserProcedureLine pUserProcedureLine)

Sets breakpoint on the line specified. Removes previously set breakpoint if exists.

Parameters:

pUserProcedureLine - line to set breakpoint on

Returns:

breakpoint object

See Also:

getBreakpointOn(OdiUserProcedureLine), removeBreakpointOn(OdiUserProcedureLine)

getBreakpointOn

public OdiDesigntimeBreakpoint getBreakpointOn(OdiUserProcedureLine pUserProcedureLine)

Returns breakpoint set on the line specified if any and null otherwise.

Parameters:

pUserProcedureLine - line to get breakpoint on

Returns:

breakpoint object

See Also:

setBreakpointOn(OdiUserProcedureLine), removeBreakpointOn(OdiUserProcedureLine)

removeBreakpointOn

public void removeBreakpointOn(OdiUserProcedureLine pUserProcedureLine)

Removes breakpoint on the line specified.

Parameters:

pUserProcedureLine - line to remove breakpoint on

See Also:

setBreakpointOn(OdiUserProcedureLine), getBreakpointOn(OdiUserProcedureLine)

isConcurrent

public boolean isConcurrent()

Returns true if concurrency enabled, false otherwise.

Returns:

if concurrency enabled.

setConcurrent

public void setConcurrent(boolean pConcurrent)

Enables concurrency if pConcurrent is true and disables it otherwise.

Parameters:

pConcurrent -

isCleanupOnError

public boolean isCleanupOnError()

Returns true if cleanup tasks should be performed on error, false otherwise.

Returns:

if cleanup tasks should be performed.

setCleanupOnError

public void setCleanupOnError(boolean pCleanupOnError)

Cleanup tasks should be performed on error is pCleanupOnError is true.

Parameters:

pCleanupOnError - if cleanup tasks should be performed on error.

getLineType

public java.lang.Class getLineType()

Specified by:

getLineType in class OdiProcedure