|
Oracle® Data Integrator Java API Reference 11g Release 1 (11.1.1.3.0) E17060-01 |
||||||||
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.OdiPackage
public class OdiPackage
Represents an ODI package.
An OdiPackage is a sequence of actions (Steps) to be build/generated into an
OdiScenario
for instance.
Step
,
Serialized FormField Summary | |
---|---|
static int |
NAME_MAX_LENGTH
Maximum name length allowed. |
Fields inherited from class oracle.odi.domain.support.AbstractOdiEntity |
---|
STARTING_INTERNAL_VERSION |
Constructor Summary | |
---|---|
OdiPackage(OdiFolder pFolder,
java.lang.String pName)
Constructor that sets the parentFolder and the name of the package. |
Method Summary | |
---|---|
java.lang.String |
getDescription()
Retrieves this OdiPackage instance description. |
Step |
getFirstStep()
Returns the first step that has to be executed for this package. |
java.io.Serializable |
getInternalId()
Returns the internal identifier of this OdiPackage instance. |
java.lang.String |
getName()
Retrieves this OdiPackage instance name. |
java.lang.Number |
getPackageId()
Returns this OdiPackage instance's internal identifier. |
OdiFolder |
getParentFolder()
Retrieves the parent OdiFolder of this OdiPackage instance. |
IRepositoryEntity |
getSecurityContainer()
Define a generic way to retrieve container for entities. |
java.util.Collection<Step> |
getSteps()
Obtains an unmodifiable collection of the steps of this package. |
boolean |
isInstanceLevelSecurityNeeded()
Internal: this method is for internal purpose and must not be considered as part of the public API. |
void |
removeStep(Step pStep)
Remove the given step from this OdiPackage instance. |
void |
setDescription(java.lang.String pDescription)
Set this OdiPackage instance description. |
void |
setFirstStep(Step pFirstStep)
Defines the first step that will be executed within this package. |
void |
setName(java.lang.String pName)
Sets the name of the package. |
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 |
Field Detail |
---|
public static final int NAME_MAX_LENGTH
Constructor Detail |
---|
public OdiPackage(OdiFolder pFolder, java.lang.String pName)
pFolder
- enclosing folderpName
- package name
java.lang.IllegalArgumentException
- if folder is null. if the name is null, empty or longer than NAME_MAX_LENGTH.Method Detail |
---|
public java.lang.String getDescription()
OdiPackage
instance description.
setDescription(java.lang.String)
public Step getFirstStep()
setFirstStep(oracle.odi.domain.project.Step)
public java.io.Serializable getInternalId()
OdiPackage
instance.
getInternalId
in interface IRepositoryEntity
getPackageId()
public java.lang.String getName()
OdiPackage
instance name.
getName
in interface IOdiEntity
getName
in class oracle.odi.domain.support.AbstractOdiEntity
setName(java.lang.String)
public java.lang.Number getPackageId()
OdiPackage
instance's internal identifier.
public OdiFolder getParentFolder()
OdiFolder
of this OdiPackage
instance.
public IRepositoryEntity getSecurityContainer()
IRepositoryEntity
getSecurityContainer
in interface IRepositoryEntity
public java.util.Collection<Step> getSteps()
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 void removeStep(Step pStep)
OdiPackage
instance.
If the given step is the first one within this package, then that method will defines the first steps found into the steps' list of this package as first step to be executed.
All the Steps referencing the removed Step as NextStepOnFailure or NextStepOnSuccess will have these properties reset to null.
Steps are automatically added to the OdiPackage
instance when using the constructor
pStep
- the step to remove
java.lang.IllegalArgumentException
- if the given step is not associated with this instance of OdiPackage or if the given step is nullpublic void setDescription(java.lang.String pDescription)
OdiPackage
instance description.
pDescription
- the package descriptiongetDescription()
public void setFirstStep(Step pFirstStep)
Reset the previous first step, if any.
pFirstStep
- the first stepgetFirstStep()
public void setName(java.lang.String pName)
pName
- package name
java.lang.IllegalArgumentException
- if the name is null, empty or longer than NAME_MAX_LENGTHgetName()
|
Oracle® Data Integrator Java API Reference 11g Release 1 (11.1.1.3.0) E17060-01 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |