|
Oracle® Data Integrator Java API Reference 11g Release 1 (11.1.1.7.0) E17060-04 |
|||||||||
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.
If a package is constructed with a reference object, the package will represented a shortcut to the reference object. When a package is used as a shortcut, most properties are accessed through the base object. The IOdiShortcutable
interface implemented by OdiPackage provides access and control over the shortcut aspects of this object.
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. |
|
OdiPackage(OdiFolder pFolder, java.lang.String pName, OdiPackage pReferencePackage) Constructor that sets the parentFolder, the name of the package, and the reference package. |
Method Summary | |
---|---|
boolean |
changeShortcutReferenceObject(OdiPackage pReferenceObject) Change the shortcut reference object. |
void |
checkValidReference(OdiPackage pReferenceObject) Internal Use Only |
java.lang.String |
getDescription() Retrieves this OdiPackage instance description. |
Step |
getFirstStep() Returns the first step that has to be executed for this package. |
java.util.Collection<IFlexFieldValue> |
getFlexFieldsValues() Obtains flex fields values related to this IFlexFieldUser . |
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. |
OdiPackage |
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. |
OdiPackage |
getShortcutBaseObject() Return the base object of this shortcutable. |
OdiPackage |
getShortcutOrigObject() If this is a shortcut, return the original base object |
OdiPackage |
getShortcutReferenceObject() If this is a shortcut, return the reference object. |
java.util.Collection<Step> |
getSteps() Obtains an unmodifiable collection of the steps of this package. |
void |
initFlexFields(IOdiFlexFieldFinder pOdiFlexFieldFinder) Initialize flex fields related to this IFlexFieldUser . |
boolean |
isInstanceLevelSecurityNeeded() Internal: this method is for internal purpose and must not be considered as part of the public API. |
boolean |
isShortcut() Returns true if this object is a shortcut. |
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. |
boolean |
setShortcutBaseObject(OdiPackage pBaseObject) Internal Use Only. |
boolean |
setShortcutReferenceObject(OdiPackage pReferenceObject) Internal Use Only. |
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, OdiPackage pReferencePackage)
pFolder
- enclosing folderpName
- package namepReferencePackage
- The reference datastore for this datastore shortcut.DomainRuntimeException
- if folder is null. if the name is null, empty or longer than NAME_MAX_LENGTH.public OdiPackage(OdiFolder pFolder, java.lang.String pName)
pFolder
- enclosing folderpName
- package nameDomainRuntimeException
- if folder is null. if the name is null, empty or longer than NAME_MAX_LENGTH.Method Detail |
---|
public java.io.Serializable getInternalId()
OdiPackage
instance.getInternalId
in interface IRepositoryEntity
getPackageId()
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 setFirstStep(Step pFirstStep)
Reset the previous first step, if any.
pFirstStep
- the first stepjava.lang.IllegalStateException
- if this is a shortcut. Use getRealObject to access.getFirstStep()
public Step getFirstStep()
java.lang.IllegalStateException
- if this is a shortcut. Use getRealObject to access.setFirstStep(oracle.odi.domain.project.Step)
public 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 removeDomainRuntimeException
- if the given step is not associated with this instance of OdiPackage or if the given step is nulljava.lang.IllegalStateException
- if this is a shortcut. Use getRealObject to access.public java.lang.String getDescription()
OdiPackage
instance description.setDescription(java.lang.String)
public void setDescription(java.lang.String pDescription)
OdiPackage
instance description.pDescription
- the package descriptiongetDescription()
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 void setName(java.lang.String pName)
pName
- package nameDomainRuntimeException
- if the name is null, empty or longer than NAME_MAX_LENGTHgetName()
public java.util.Collection<Step> getSteps()
java.lang.IllegalStateException
- if this is a shortcut. Use getRealObject to access.public java.lang.Number getPackageId()
OdiPackage
instance's internal identifier.public IRepositoryEntity getSecurityContainer()
IRepositoryEntity
getSecurityContainer
in interface IRepositoryEntity
public OdiFolder getParentFolder()
OdiFolder
of this OdiPackage
instance.public java.util.Collection<IFlexFieldValue> getFlexFieldsValues()
IFlexFieldUser
IFlexFieldUser
.getFlexFieldsValues
in interface IFlexFieldUser
public void initFlexFields(IOdiFlexFieldFinder pOdiFlexFieldFinder)
IFlexFieldUser
IFlexFieldUser
.initFlexFields
in interface IFlexFieldUser
pOdiFlexFieldFinder
- OdiFlexField
finder to be used to query flex fieldspublic OdiPackage 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<OdiPackage>
public boolean setShortcutBaseObject(OdiPackage 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<OdiPackage>
pBaseObject
- new base object.public OdiPackage getShortcutReferenceObject()
IOdiShortcutable
The reference object may also be a shortcut.
getShortcutReferenceObject
in interface IOdiShortcutable<OdiPackage>
public boolean setShortcutReferenceObject(OdiPackage 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<OdiPackage>
pReferenceObject
- new shortcutable object. Can be be nullpublic OdiPackage getShortcutOrigObject()
IOdiShortcutable
The reference object may also be a shortcut.
getShortcutOrigObject
in interface IOdiShortcutable<OdiPackage>
public boolean isShortcut()
IOdiShortcutable
isShortcut
in interface IOdiShortcutable<OdiPackage>
public IReleaseTag getReleaseTag()
IOdiShortcutable
release tag is actually maintained on the container object. This provides consistent access to the tag.
getReleaseTag
in interface IOdiShortcutable<OdiPackage>
public OdiPackage 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<OdiPackage>
public void checkValidReference(OdiPackage pReferenceObject)
IOdiShortcutable
checkValidReference
in interface IOdiShortcutable<OdiPackage>
public boolean changeShortcutReferenceObject(OdiPackage pReferenceObject)
IOdiShortcutable
If pReferenceObject's base object is same as the base object of shortcut, the shortcut will have pReferenceObject as new reference. It will return true.
If pReferenceObject's base object is not same as the base of the shortcut, the shortcut reference object won't be changed. It will return false.
If pReferenceObject is null, the shortcut reference object won't be changed. It will return false.
If current object is not shortcut, nothing will be changed. It will return false.
changeShortcutReferenceObject
in interface IOdiShortcutable<OdiPackage>
pReferenceObject
- new reference object. Can be be null
|
Oracle® Data Integrator Java API Reference 11g Release 1 (11.1.1.7.0) E17060-04 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |