|
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<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).
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. |
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, getFlexFieldsValues, getInternalId, getLines, getName, getOption, getOptionNames, getOptions, getProcedureId, initFlexFields, 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 |
---|
public OdiUserProcedure(OdiFolder pFolder, java.lang.String pName)
OdiFolder
and the name of this OdiUserProcedure
instance.
pFolder
- owning folderpName
- name of OdiUserProcedurejava.lang.IllegalArgumentException
- 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()
public java.lang.Number getInstanceId()
getInstanceId
in interface oracle.odi.domain.procusage.IProcedureUser
|
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 |