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, IExportable, IOdiEntity, IRepositoryEntity, IWorkDevelopmentOdiEntity, IOdiScenarioSource

public class OdiPackage
extends oracle.odi.domain.support.AbstractOdiEntity
implements IOdiScenarioSource, IWorkDevelopmentOdiEntity, IExportable

Represents an ODI package.

An OdiPackage is a sequence of actions (Steps) to be build/generated into an OdiScenario for instance.

Since:

11.1.1.3.0

See Also:

Step, Serialized Form

Field 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

NAME_MAX_LENGTH

public static final int NAME_MAX_LENGTH

Maximum name length allowed.

See Also:

Constant Field Values

Constructor Detail

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:

java.lang.IllegalArgumentException - if folder is null. if the name is null, empty or longer than NAME_MAX_LENGTH.

Method Detail

getDescription

public java.lang.String getDescription()

Retrieves this OdiPackage instance description.

Returns:

a String representing the description value

See Also:

setDescription(java.lang.String)

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

See Also:

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

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()

getName

public java.lang.String getName()

Retrieves this OdiPackage instance name.

Specified by:

getName in interface IOdiEntity

Overrides:

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

Returns:

the name

See Also:

setName(java.lang.String)

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

getSecurityContainer

public IRepositoryEntity getSecurityContainer()

Description copied from interface: IRepositoryEntity

Define a generic way to retrieve container for entities.

Specified by:

getSecurityContainer in interface IRepositoryEntity

Returns:

container entity

getSteps

public java.util.Collection<Step> getSteps()

Obtains an unmodifiable collection of the steps of this package.

Returns:

a Collection object representing the steps value

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

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:

java.lang.IllegalArgumentException - if the given step is not associated with this instance of OdiPackage or if the given step is null

setDescription

public void setDescription(java.lang.String pDescription)

Set this OdiPackage instance description.

Parameters:

pDescription - the package description

See Also:

getDescription()

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

See Also:

getFirstStep()

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:

java.lang.IllegalArgumentException - if the name is null, empty or longer than NAME_MAX_LENGTH

See Also:

getName()