Skip navigation links

oracle.odi.domain.project
Class OdiProject

java.lang.Object
oracle.odi.domain.support.BusinessObject
oracle.odi.domain.support.AbstractRepositoryEntity
oracle.odi.domain.support.AbstractOdiEntity
oracle.odi.domain.project.OdiProject

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, IFlexFieldUser, IExportable, IImportRoot, IOdiEntity, IRepositoryEntity, IWorkDevelopmentOdiEntity, IOdiScenarioSourceContainer

public class OdiProject

extends oracle.odi.domain.support.AbstractOdiEntity

implements IImportRoot, IOdiScenarioSourceContainer, IWorkDevelopmentOdiEntity, IExportable, IFlexFieldUser

An OdiProject is a top level workbench object in ODI.

An integration project is composed of several components. These components include organizational objects, such as folder, and development objects such as interfaces or variables.

Since:

11.1.1.3.0

See Also:

Serialized Form

Field Summary

static int	CODE_MAX_LENGTH Maximum length of an Odi Project's code.
static java.lang.String	GLOBAL_PROJECT_PREFIX Project prefix for "Global" scope objects
static int	NAME_MAX_LENGTH Maximum length of an Odi Project's name.

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

STARTING_INTERNAL_VERSION

Constructor Summary

OdiProject(java.lang.String pName, java.lang.String pCode)
Constructs an OdiProject object.

Method Summary

void	addFolder(OdiFolder pFolder) Add the given OdiFolder to the collection of OdiFolders.
OdiSKM	addSKM(java.lang.String pName) Deprecated. replaced by constructor OdiSKM.OdiSKM(OdiProject pProject, String pName)
java.util.Collection<OdiCKM>	getCKMs() Return the unmodifiable collection of CKMs of this OdiProject.
java.lang.String	getCode() Return the OdiProject code.
java.util.Collection<IFlexFieldValue>	getFlexFieldsValues() Obtains flex fields values related to this IFlexFieldUser.
java.util.Collection<OdiFolder>	getFolders() Obtains the unmodifable collection of OdiFolders.
java.util.Collection<OdiIKM>	getIKMs() Return the unmodifiable collection of IKMs (Integration Knowledge Modules) of this OdiProject.
java.io.Serializable	getInternalId() Provides a common getter for the persistence layer to obtain an identity, irrespective of the actual type of identity used.
java.util.Collection<OdiJKM>	getJKMs() Return the unmodifiable collection of JKMs of this OdiProject.
java.util.Collection<OdiLKM>	getLKMs() Return the unmodifiable collection of LKMs of this OdiProject.
java.lang.String	getName() Returns the OdiProject's name.
java.lang.Number	getProjectId() Return the project identifier.
java.util.Collection<OdiRKM>	getRKMs() Return the unmodifiable collection of RKMs of this OdiProject.
IRepositoryEntity	getSecurityContainer() Define a generic way to retrieve container for entities.
java.util.Collection<OdiSequence>	getSequences() Return the unmodifiable collection of sequences that belong to this project.
java.util.Collection<OdiSKM>	getSKMs() Return the unmodifiable collection of SKMs of this OdiProject.
java.util.Collection<OdiUserFunction>	getUserFunctions() Return an unmodifiable collection of user functions that belong to this project.
java.util.Collection<OdiVariable>	getVariables() Obtains the unmodifable collection of OdiVariables. Use removeVariable(OdiVariable) to remove elements from this collection.
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.
void	removeCKM(OdiCKM pKM) Remove the given OdiCKM from the collection of OdiCKMs.
void	removeFolder(OdiFolder pFolder) Remove the given OdiFolder from the collection of OdiFolders.
void	removeIKM(OdiIKM pKM) Remove the given OdiIKM from the collection of OdiIKMs.
void	removeJKM(OdiJKM pKM) Remove the given OdiJKM from the collection of OdiJKMs.
void	removeLKM(OdiLKM pKM) Remove the given OdiLKM from the collection of OdiLKMs.
void	removeRKM(OdiRKM pKM) Remove the given OdiRKM from the collection of OdiRKMs.
void	removeSequence(OdiSequence pSequence) Remove the given OdiSequence from the collection of OdiSequences.
void	removeSKM(OdiSKM pKM) Remove the given OdiSKM from the collection of OdiSKMs.
void	removeUserFunction(OdiUserFunction pUserFunction) Remove the given OdiUserFunction from the collection of OdiUserFunctions.
void	removeVariable(OdiVariable pVariable) Remove the given OdiVariable from the collection of OdiVariables.
void	setCode(java.lang.String pCode) Sets the code of this OdiProject instance.
void	setName(java.lang.String pName) Sets the name of this OdiProject.
boolean	supportsImport(java.lang.Class<IOdiEntity> pChildClass) For now only OdiKM and its subclasses could be imported to an OdiProject.

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

CODE_MAX_LENGTH

public static final int CODE_MAX_LENGTH

Maximum length of an Odi Project's code.

See Also:

Constant Field Values

NAME_MAX_LENGTH

public static final int NAME_MAX_LENGTH

Maximum length of an Odi Project's name.

See Also:

Constant Field Values

GLOBAL_PROJECT_PREFIX

public static final java.lang.String GLOBAL_PROJECT_PREFIX

Project prefix for "Global" scope objects

Since:

11.1.1.5.0

See Also:

Constant Field Values

Constructor Detail

OdiProject

public OdiProject(java.lang.String pName,
                  java.lang.String pCode)

Constructs an OdiProject object.

Parameters:

pName - project name

pCode - project code

Method Detail

getVariables

public java.util.Collection<OdiVariable> getVariables()

Obtains the unmodifable collection of OdiVariables.
Use removeVariable(OdiVariable) to remove elements from this collection.

Returns:

a Collection object representing the variables value

See Also:

removeVariable(OdiVariable)

removeVariable

public void removeVariable(OdiVariable pVariable)

Remove the given OdiVariable from the collection of OdiVariables.
This will also reset the OdiProject of the given OdiVariable to null.

Parameters:

pVariable - an OdiVariable object

Throws:

java.lang.IllegalArgumentException - if pVariable is null or does not belong to this OdiProject

removeSequence

public void removeSequence(OdiSequence pSequence)

Remove the given OdiSequence from the collection of OdiSequences.
This will also reset the OdiProject of the given OdiSequence to null.

Parameters:

pSequence - an OdiSequence object

Throws:

java.lang.IllegalArgumentException - if pSequence is null or does not belong to this OdiProject

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

getFolders

public java.util.Collection<OdiFolder> getFolders()

Obtains the unmodifable collection of OdiFolders.

Use removeFolder(OdiFolder) and addFolder(OdiFolder) to respectively add and remove OdiFolder.

Returns:

a Collection object representing the folders value

See Also:

addFolder(OdiFolder), removeFolder(OdiFolder)

addFolder

public void addFolder(OdiFolder pFolder)

Add the given OdiFolder to the collection of OdiFolders.

This will also set the Project of the given OdiFolder to this OdiProject instance.

If the given OdiFolder was already associated to an other OdiProject it will be removed from this one.

Parameters:

pFolder - an OdiFolder object

Throws:

java.lang.IllegalArgumentException - if pFolder is null or if you try to move this pFolder from an OdiProject to an other.

removeFolder

public void removeFolder(OdiFolder pFolder)

Remove the given OdiFolder from the collection of OdiFolders.

This will also reset the OdiProject of the given OdiFolder to null making the given OdiFolder a root OdiFolder.

Note: You will have to call IOdiEntityManager.remove(pFolder) too in order to remove the OdiFolder from the repository

Parameters:

pFolder - an OdiFolder object

Throws:

java.lang.IllegalArgumentException - if pFolder is null or does not belong to this OdiProject

getCode

public java.lang.String getCode()

Return the OdiProject code. It can't be null, it is uppercase and max length is 35.

Returns:

a String representing the code value

See Also:

setCode(String)

setCode

public void setCode(java.lang.String pCode)

Sets the code of this OdiProject instance.
pCode must shorter or as long as CODE_MAX_LENGTH.
Can't be null.
Code must be uppercase.
" " (space) is an invalid character.

Parameters:

pCode - a String representing the code value

Throws:

java.lang.IllegalArgumentException - if code is null or empty, is longer than CODE_MAX_LENGTH, is not uppercase, contains whitespaces

See Also:

getCode(), CODE_MAX_LENGTH

getName

public java.lang.String getName()

Returns the OdiProject's name.

Specified by:

getName in interface IOdiEntity

Overrides:

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

Returns:

a String specifying the name value

See Also:

setName(java.lang.String)

setName

public void setName(java.lang.String pName)

Sets the name of this OdiProject. It can't be null or empty and must 35 characters long max.

Parameters:

pName - a String specifying the name value

Throws:

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

See Also:

getName(), NAME_MAX_LENGTH

getProjectId

public java.lang.Number getProjectId()

Return the project identifier.

Returns:

a Number object representing the project id value

getSequences

public java.util.Collection<OdiSequence> getSequences()

Return the unmodifiable collection of sequences that belong to this project.

Returns:

a Collection object representing the sequences value

getUserFunctions

public java.util.Collection<OdiUserFunction> getUserFunctions()

Return an unmodifiable collection of user functions that belong to this project.

Returns:

a Collection object representing the user functions value

getIKMs

public java.util.Collection<OdiIKM> getIKMs()

Return the unmodifiable collection of IKMs (Integration Knowledge Modules) of this OdiProject.

Returns:

a Collection object representing the IKMs value

getCKMs

public java.util.Collection<OdiCKM> getCKMs()

Return the unmodifiable collection of CKMs of this OdiProject.

Returns:

a Collection object representing the CKMs value

getLKMs

public java.util.Collection<OdiLKM> getLKMs()

Return the unmodifiable collection of LKMs of this OdiProject.

Returns:

a Collection object representing the LKMs value

getJKMs

public java.util.Collection<OdiJKM> getJKMs()

Return the unmodifiable collection of JKMs of this OdiProject.

Returns:

a Collection object representing the JKMs value

getRKMs

public java.util.Collection<OdiRKM> getRKMs()

Return the unmodifiable collection of RKMs of this OdiProject.

Returns:

a Collection object representing the RKMs value

getSKMs

public java.util.Collection<OdiSKM> getSKMs()

Return the unmodifiable collection of SKMs of this OdiProject.

Returns:

a Collection object representing the SKMs value

getInternalId

public java.io.Serializable getInternalId()

Description copied from interface: IRepositoryEntity

Provides a common getter for the persistence layer to obtain an identity, irrespective of the actual type of identity used.

Typically a subclass will delegate to a public SomePrimitiveWrapper getId() method. The necessity for the getInternalId() abstract method is solely because the persistence layer needs a way of obtaining the identity irrespective of the actual identity implementation choice.

Returning null from this method will indicate the object has never been saved. This will likely be relied on by some DAO implementations.

Specified by:

getInternalId in interface IRepositoryEntity

Returns:

the persistence identity of this instance

removeCKM

public void removeCKM(OdiCKM pKM)

Remove the given OdiCKM from the collection of OdiCKMs.

This will also reset the OdiProject of the given OdiCKM to null making the given OdiCKM a root OdiCKM.

Note: You will have to call IOdiEntityManager.remove(pKM) too in order to remove the OdiCKM from the repository

Parameters:

pKM - an OdiCKM object

Throws:

java.lang.IllegalArgumentException - if pKM is null or does not belong to this OdiProject

removeIKM

public void removeIKM(OdiIKM pKM)

Remove the given OdiIKM from the collection of OdiIKMs.

This will also reset the OdiProject of the given OdiIKM to null making the given OdiIKM a root OdiIKM.

Note: You will have to call IOdiEntityManager.remove(pKM) too in order to remove the OdiIKM from the repository

Parameters:

pKM - an OdiIKM object

Throws:

java.lang.IllegalArgumentException - if pKM is null or does not belong to this OdiProject

removeJKM

public void removeJKM(OdiJKM pKM)

Remove the given OdiJKM from the collection of OdiJKMs.

This will also reset the OdiProject of the given OdiJKM to null making the given OdiJKM a root OdiJKM.

Note: You will have to call IOdiEntityManager.remove(pKM) too in order to remove the OdiJKM from the repository

Parameters:

pKM - an OdiJKM object

Throws:

java.lang.IllegalArgumentException - if pKM is null or does not belong to this OdiProject

removeLKM

public void removeLKM(OdiLKM pKM)

Remove the given OdiLKM from the collection of OdiLKMs.

This will also reset the OdiProject of the given OdiLKM to null making the given OdiLKM a root OdiLKM.

Note: You will have to call IOdiEntityManager.remove(pKM) too in order to remove the OdiLKM from the repository

Parameters:

pKM - an OdiLKM object

Throws:

java.lang.IllegalArgumentException - if pKM is null or does not belong to this OdiProject

removeRKM

public void removeRKM(OdiRKM pKM)

Remove the given OdiRKM from the collection of OdiRKMs.

This will also reset the OdiProject of the given OdiRKM to null making the given OdiRKM a root OdiRKM.

Note: You will have to call IOdiEntityManager.remove(pKM) too in order to remove the OdiRKM from the repository

Parameters:

pKM - an OdiRKM object

Throws:

java.lang.IllegalArgumentException - if pKM is null or does not belong to this OdiProject

addSKM

public OdiSKM addSKM(java.lang.String pName)

Deprecated. replaced by constructor OdiSKM.OdiSKM(OdiProject pProject, String pName)

Create and add a OdiSKM to this project

Parameters:

pName -

Returns:

removeSKM

public void removeSKM(OdiSKM pKM)

Remove the given OdiSKM from the collection of OdiSKMs.

This will also reset the OdiProject of the given OdiSKM to null making the given OdiSKM a root OdiSKM.

Note: You will have to call IOdiEntityManager.remove(pKM) too in order to remove the OdiSKM from the repository

Parameters:

pKM - an OdiSKM object

Throws:

java.lang.IllegalArgumentException - if pKM is null or does not belong to this OdiProject

supportsImport

public boolean supportsImport(java.lang.Class<IOdiEntity> pChildClass)

For now only OdiKM and its subclasses could be imported to an OdiProject.

Specified by:

supportsImport in interface IImportRoot

Parameters:

pChildClass - the class of object to be imported into this one

Returns:

true if the given type could be imported, false otherwise

See Also:

IImportRoot.supportsImport(java.lang.Class)

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

removeUserFunction

public void removeUserFunction(OdiUserFunction pUserFunction)

Remove the given OdiUserFunction from the collection of OdiUserFunctions.

Parameters:

pUserFunction - - OdiUserFunction to remove

Throws:

java.lang.IllegalArgumentException - if pUserFunction is null or does not belong to this OdiProject

Since:

11.1.1.5.0

getFlexFieldsValues

public java.util.Collection<IFlexFieldValue> getFlexFieldsValues()

Description copied from interface: IFlexFieldUser

Obtains flex fields values related to this IFlexFieldUser.

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

Skip navigation links