public class OdiPackage extends oracle.odi.domain.support.AbstractOdiEntity implements oracle.odi.domain.shortcuts.IOdiShortcutable, IOdiScenarioSource, IWorkDevelopmentOdiEntity, oracle.odi.domain.impexp.IExportable, IFlexFieldUser, oracle.odi.impexp.smartie.ISmartExportable
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 FormModifier and Type | Field and Description |
---|---|
static int |
NAME_MAX_LENGTH
Maximum name length allowed.
|
Constructor and Description |
---|
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.
|
Modifier and Type | Method and Description |
---|---|
boolean |
changeShortcutReferenceObject(OdiPackage pReferenceObject) |
void |
checkValidReference(OdiPackage pReferenceObject) |
OdiDesigntimeBreakpoint |
getBreakpointOn(Step pStep)
Returns breakpoint set on the step specified if any and
null
otherwise. |
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 |
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() |
IReleaseTag |
getReleaseTag() |
IRepositoryEntity |
getSecurityContainer()
Define a generic way to retrieve container for entities.
|
OdiPackage |
getShortcutBaseObject() |
OdiPackage |
getShortcutOrigObject() |
OdiPackage |
getShortcutReferenceObject() |
java.util.Collection |
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() |
void |
removeBreakpointOn(Step pStep)
Removes breakpoint on the step specified.
|
void |
removeStep(Step pStep)
Remove the given step from this
OdiPackage instance. |
OdiDesigntimeBreakpoint |
setBreakpointOn(Step pStep)
Sets breakpoint on the step specified.
|
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) |
boolean |
setShortcutReferenceObject(OdiPackage pReferenceObject) |
equals, getFirstDate, getFirstUser, getInternalVersion, getLastDate, getLastUser, hashCode, isNew, toString
getGlobalId, getNumericId, hasCustomizedPersistenceMethodFor, invokeCustomizedPersistenceMethodFor
getFirstDate, getFirstUser, getLastDate, getLastUser
getGlobalId
public static final int NAME_MAX_LENGTH
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.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 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 getFlexFieldsValues()
IFlexFieldUser
.
In most implementations method initFlexFields(IOdiFlexFieldFinder)
should be
called before calling this method.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 OdiDesigntimeBreakpoint setBreakpointOn(Step pStep)
pStep
- step to set breakpoint ongetBreakpointOn(Step)
,
removeBreakpointOn(Step)
public OdiDesigntimeBreakpoint getBreakpointOn(Step pStep)
null
otherwise.pStep
- step to get breakpoint onsetBreakpointOn(Step)
,
removeBreakpointOn(Step)
public void removeBreakpointOn(Step pStep)
pStep
- step to remove breakpoint onsetBreakpointOn(Step)
,
getBreakpointOn(Step)
public OdiPackage getShortcutBaseObject()
getShortcutBaseObject
in interface oracle.odi.domain.shortcuts.IOdiShortcutable
public boolean setShortcutBaseObject(OdiPackage pBaseObject)
setShortcutBaseObject
in interface oracle.odi.domain.shortcuts.IOdiShortcutable
public OdiPackage getShortcutReferenceObject()
getShortcutReferenceObject
in interface oracle.odi.domain.shortcuts.IOdiShortcutable
public boolean setShortcutReferenceObject(OdiPackage pReferenceObject)
setShortcutReferenceObject
in interface oracle.odi.domain.shortcuts.IOdiShortcutable
public OdiPackage getShortcutOrigObject()
getShortcutOrigObject
in interface oracle.odi.domain.shortcuts.IOdiShortcutable
public boolean isShortcut()
isShortcut
in interface oracle.odi.domain.shortcuts.IOdiShortcutable
public IReleaseTag getReleaseTag()
getReleaseTag
in interface oracle.odi.domain.shortcuts.IOdiShortcutable
public OdiPackage getRealObject()
getRealObject
in interface oracle.odi.domain.shortcuts.IOdiShortcutable
public void checkValidReference(OdiPackage pReferenceObject)
checkValidReference
in interface oracle.odi.domain.shortcuts.IOdiShortcutable
public boolean changeShortcutReferenceObject(OdiPackage pReferenceObject)
changeShortcutReferenceObject
in interface oracle.odi.domain.shortcuts.IOdiShortcutable