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<OdiUserProcedureLine>
                  oracle.odi.domain.project.OdiUserProcedure

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, IExportable, IOdiEntity, IRepositoryEntity, IWorkDevelopmentOdiEntity, oracle.odi.domain.procusage.IProcedureUser, IOdiScenarioSource

public final class OdiUserProcedure
extends OdiProcedure<OdiUserProcedureLine>
implements IOdiScenarioSource, IExportable, oracle.odi.domain.procusage.IProcedureUser

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).

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

OdiUserProcedure(OdiFolder pFolder, java.lang.String pName)
Constructor that sets the parent OdiFolder and the name of this OdiUserProcedure instance.

Method Summary

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()
IRepositoryEntity	getSecurityContainer() Define a generic way to retrieve container for entities.
boolean	isInstanceLevelSecurityNeeded() Internal: this method is for internal purpose and must not be considered as part of the public API.

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

addLine, addLine, addOption, addOption, getDefaultSourceTechnology, getDefaultTargetTechnology, getDescription, getInternalId, getLines, getName, getOption, getOptionNames, getOptions, getProcedureId, isMultiConnectionSupported, moveLineAfter, moveLineBefore, removeLine, removeOption, setDefaultSourceTechnology, setDefaultTargetTechnology, setDescription, setMultiConnectionSupported, 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

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:

java.lang.IllegalArgumentException - 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

getExecutionOptions

public java.util.Collection<IOptionValue> 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

getFolder

public OdiFolder getFolder()

Return the parent OdiFolder.

Returns:

OdiFolder

See Also:

OdiFolder, setFolder(OdiFolder)

getInstanceId

public java.lang.Number getInstanceId()

Specified by:

getInstanceId in interface oracle.odi.domain.procusage.IProcedureUser

getSecurityContainer

public IRepositoryEntity getSecurityContainer()

Description copied from interface: IRepositoryEntity

Define a generic way to retrieve container for entities.

Specified by:

getSecurityContainer in interface IRepositoryEntity

Overrides:

getSecurityContainer in class OdiProcedure<OdiUserProcedureLine>

Returns:

container entity

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