oracle.odi.domain.project

Class OdiPackage

java.lang.Object

oracle.odi.domain.support.BusinessObject

oracle.odi.domain.support.AbstractRepositoryEntity

oracle.odi.domain.support.AbstractOdiEntity

oracle.odi.domain.project.OdiPackage

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, oracle.odi.core.audit.support.IAuditableFirstClassObject, IFlexFieldUser, oracle.odi.domain.impexp.IExportable, IOdiEntity, IRepositoryEntity, IWorkDevelopmentOdiEntity, IOdiScenarioSource, oracle.odi.domain.shortcuts.IOdiShortcutable, oracle.odi.impexp.smartie.ISmartExportable

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, oracle.odi.core.audit.support.IAuditableFirstClassObject

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.

Since:

11.1.1.3.0

See Also:

Step, Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static int	NAME_MAX_LENGTH Maximum name length allowed.

Fields inherited from class oracle.odi.domain.support.AbstractOdiEntity

STARTING_INTERNAL_VERSION

Constructor Summary

Constructors

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.

Method Summary

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()
OdiPackage	getShortcutBaseObject()
OdiPackage	getShortcutOrigObject() Deprecated.
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)

Methods inherited from class oracle.odi.domain.support.AbstractOdiEntity

getFirstDate, getFirstUser, getInternalVersion, getLastDate, getLastUser, isNew, preCommit, toString

Methods inherited from class oracle.odi.domain.support.AbstractRepositoryEntity

equals, getGlobalId, getNumericId, getParent, hashCode

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

Methods inherited from interface oracle.odi.domain.IRepositoryEntity

getGlobalId, getParent

Field Detail

NAME_MAX_LENGTH

public static final int NAME_MAX_LENGTH

Maximum name length allowed.

See Also:

Constant Field Values

Constructor Detail

OdiPackage

public OdiPackage(java.lang.String name)

Parameters:

name -

OdiPackage

public OdiPackage(OdiFolder pFolder,
                  java.lang.String pName,
                  OdiPackage pReferencePackage)

Constructor that sets the parentFolder, the name of the package, and the reference package. If pReferencePackage is not null, this object will is a package shortcut.

Parameters:

pFolder - enclosing folder

pName - package name

pReferencePackage - The reference datastore for this datastore shortcut.

Throws:

DomainRuntimeException - if folder is null. if the name is null, empty or longer than NAME_MAX_LENGTH.

OdiPackage

public OdiPackage(OdiFolder pFolder,
                  java.lang.String pName)

Constructor that sets the parentFolder and the name of the package.

Parameters:

pFolder - enclosing folder

pName - package name

Throws:

DomainRuntimeException - if folder is null. if the name is null, empty or longer than NAME_MAX_LENGTH.

Method Detail

getInternalId

public java.io.Serializable getInternalId()

Returns the internal identifier of this OdiPackage instance.

Specified by:

getInternalId in interface IRepositoryEntity

Returns:

the persistence identity of this instance

See Also:

getPackageId()

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

setFirstStep

public void setFirstStep(Step pFirstStep)

Defines the first step that will be executed within this package.

Reset the previous first step, if any.

Parameters:

pFirstStep - the first step

Throws:

java.lang.IllegalStateException - if this is a shortcut. Use getRealObject to access.

See Also:

getFirstStep()

getFirstStep

public Step getFirstStep()

Returns the first step that has to be executed for this package.

Returns:

a Step object representing the first step value

Throws:

java.lang.IllegalStateException - if this is a shortcut. Use getRealObject to access.

See Also:

setFirstStep(oracle.odi.domain.project.Step)

removeStep

public void removeStep(Step pStep)

Remove the given step from this 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

Parameters:

pStep - the step to remove

Throws:

DomainRuntimeException - if the given step is not associated with this instance of OdiPackage or if the given step is null

java.lang.IllegalStateException - if this is a shortcut. Use getRealObject to access.

getDescription

public java.lang.String getDescription()

Retrieves this OdiPackage instance description.

Returns:

a String representing the description value

See Also:

setDescription(java.lang.String)

setDescription

public void setDescription(java.lang.String pDescription)

Set this OdiPackage instance description.

Parameters:

pDescription - the package description

See Also:

getDescription()

getName

public java.lang.String getName()

Retrieves this OdiPackage instance name.

Specified by:

getName in interface IFlexFieldUser

Specified by:

getName in interface IOdiEntity

Overrides:

getName in class oracle.odi.domain.support.AbstractOdiEntity

Returns:

the name

See Also:

setName(java.lang.String)

setName

public void setName(java.lang.String pName)

Sets the name of the package. It can't be null or empty and must be not be longer than NAME_MAX_LENGTH.

Parameters:

pName - package name

Throws:

DomainRuntimeException - if the name is null, empty or longer than NAME_MAX_LENGTH

See Also:

getName()

getSteps

public java.util.Collection getSteps()

Obtains an unmodifiable collection of the steps of this package.

Returns:

a Collection object representing the steps value

Throws:

java.lang.IllegalStateException - if this is a shortcut. Use getRealObject to access.

getPackageId

public java.lang.Number getPackageId()

Returns this OdiPackage instance's internal identifier.

Returns:

a Number object representing the package id value

getParentFolder

public OdiFolder getParentFolder()

Retrieves the parent OdiFolder of this OdiPackage instance.

Returns:

an OdiFolder object representing the parent folder value

getFlexFieldsValues

public java.util.Collection getFlexFieldsValues()

Obtains flex fields values related to this IFlexFieldUser. In most implementations method initFlexFields(IOdiFlexFieldFinder) should be called before calling this method.

Specified by:

getFlexFieldsValues in interface IFlexFieldUser

Returns:

an unmodifiable Collection of flex field values

Since:

11.1.1.5.0

initFlexFields

public void initFlexFields(IOdiFlexFieldFinder pOdiFlexFieldFinder)

Description copied from interface: IFlexFieldUser

Initialize flex fields related to this IFlexFieldUser.

Specified by:

initFlexFields in interface IFlexFieldUser

Parameters:

pOdiFlexFieldFinder - OdiFlexField finder to be used to query flex fields

Since:

11.1.1.5.0

setBreakpointOn

public OdiDesigntimeBreakpoint setBreakpointOn(Step pStep)

Sets breakpoint on the step specified. Removes previously set breakpoint if exists.

Parameters:

pStep - step to set breakpoint on

Returns:

breakpoint object

See Also:

getBreakpointOn(Step), removeBreakpointOn(Step)

getBreakpointOn

public OdiDesigntimeBreakpoint getBreakpointOn(Step pStep)

Returns breakpoint set on the step specified if any and null otherwise.

Parameters:

pStep - step to get breakpoint on

Returns:

breakpoint object

See Also:

setBreakpointOn(Step), removeBreakpointOn(Step)

removeBreakpointOn

public void removeBreakpointOn(Step pStep)

Removes breakpoint on the step specified.

Parameters:

pStep - step to remove breakpoint on

See Also:

setBreakpointOn(Step), getBreakpointOn(Step)

getShortcutBaseObject

public OdiPackage getShortcutBaseObject()

Specified by:

getShortcutBaseObject in interface oracle.odi.domain.shortcuts.IOdiShortcutable

setShortcutBaseObject

public boolean setShortcutBaseObject(OdiPackage pBaseObject)

Specified by:

setShortcutBaseObject in interface oracle.odi.domain.shortcuts.IOdiShortcutable

getShortcutReferenceObject

public OdiPackage getShortcutReferenceObject()

Specified by:

getShortcutReferenceObject in interface oracle.odi.domain.shortcuts.IOdiShortcutable

setShortcutReferenceObject

public boolean setShortcutReferenceObject(OdiPackage pReferenceObject)

Specified by:

setShortcutReferenceObject in interface oracle.odi.domain.shortcuts.IOdiShortcutable

getShortcutOrigObject

public OdiPackage getShortcutOrigObject()

Deprecated.

Specified by:

getShortcutOrigObject in interface oracle.odi.domain.shortcuts.IOdiShortcutable

isShortcut

public boolean isShortcut()

Specified by:

isShortcut in interface oracle.odi.domain.shortcuts.IOdiShortcutable

getReleaseTag

public IReleaseTag getReleaseTag()

Specified by:

getReleaseTag in interface oracle.odi.domain.shortcuts.IOdiShortcutable

getRealObject

public OdiPackage getRealObject()

Specified by:

getRealObject in interface oracle.odi.domain.shortcuts.IOdiShortcutable

checkValidReference

public void checkValidReference(OdiPackage pReferenceObject)

Specified by:

checkValidReference in interface oracle.odi.domain.shortcuts.IOdiShortcutable

changeShortcutReferenceObject

public boolean changeShortcutReferenceObject(OdiPackage pReferenceObject)

Specified by:

changeShortcutReferenceObject in interface oracle.odi.domain.shortcuts.IOdiShortcutable