public class OdiProject extends oracle.odi.domain.support.AbstractOdiEntity implements IProject, IImportRoot, IOdiScenarioSourceContainer, IWorkDevelopmentOdiEntity, oracle.odi.domain.impexp.IExportable, IFlexFieldUser, oracle.odi.impexp.smartie.ISmartExportable, oracle.odi.core.audit.support.IAuditableFirstClassObject
An integration project is composed of several components. These components include organizational objects, such as folder, and development objects such as interfaces or variables.
Modifier and Type | Field and Description |
---|---|
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.
|
Constructor and Description |
---|
OdiProject(java.lang.String pName,
java.lang.String pCode)
Constructs an OdiProject object.
|
Modifier and Type | Method and Description |
---|---|
void |
addComponentKM(IKnowledgeModule compKM)
Adds a component KM to this project.
|
void |
addFolder(OdiFolder pFolder)
|
OdiSKM |
addSKM(java.lang.String pName)
Deprecated.
replaced by constructor
OdiSKM.OdiSKM(OdiProject pProject, String pName) |
java.util.List |
getAllKMs()
Gets a list of all mapping-related project KMs (of all types) that are owned by the project.
|
java.util.Collection |
getCKMs()
Return the unmodifiable collection of CKMs of this
OdiProject . |
java.lang.String |
getCode()
Return the
OdiProject code. |
java.util.Collection |
getComponentKMs()
Return the unmodifiable collection of ComponentKMs of this
OdiProject . |
java.util.Collection |
getFlexFieldsValues()
Obtains flex fields values related to this
IFlexFieldUser . |
java.util.Collection |
getFolders()
Obtains the unmodifable collection of
OdiFolder s. |
java.util.Collection |
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 |
getJKMs()
Return the unmodifiable collection of JKMs of this
OdiProject . |
java.util.List |
getKMs(IKnowledgeModule.KMType type)
Get a list of all component KMs of the specified type.
|
java.util.Collection |
getLKMs()
Return the unmodifiable collection of LKMs of this
OdiProject . |
java.util.Collection |
getMarkerGroups() |
java.lang.String |
getName()
Returns the
OdiProject 's name. |
java.lang.Number |
getProjectId()
Return the project identifier.
|
java.util.Collection |
getRKMs()
Return the unmodifiable collection of RKMs of this
OdiProject . |
IRepositoryEntity |
getSecurityContainer()
Define a generic way to retrieve container for entities.
|
java.util.Collection |
getSequences()
Return the unmodifiable collection of sequences that belong to this project.
|
java.util.Collection |
getSKMs()
Return the unmodifiable collection of SKMs of this
OdiProject . |
java.util.Collection |
getUserFunctions()
Return an unmodifiable collection of user functions that belong to this project.
|
java.util.Collection |
getVariables()
Obtains the unmodifiable collection of
OdiVariable s.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)
|
void |
removeComponentKM(ComponentKM pKM)
Remove the given
ComponentKM from the collection of ComponentKM s. |
void |
removeFolder(OdiFolder pFolder)
|
void |
removeIKM(OdiIKM pKM)
|
void |
removeJKM(OdiJKM pKM)
|
void |
removeLKM(OdiLKM pKM)
|
void |
removeRKM(OdiRKM pKM)
|
void |
removeSequence(OdiSequence pSequence)
Remove the given
OdiSequence from the collection of OdiSequence s. |
void |
removeSKM(OdiSKM pKM)
|
void |
removeUserFunction(OdiUserFunction pUserFunction)
Remove the given
OdiUserFunction from the collection of OdiUserFunction s. |
void |
removeVariable(OdiVariable pVariable)
Remove the given
OdiVariable from the collection of OdiVariable s. |
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 pChildClass)
For now only
OdiKM and its subclasses could be imported to an OdiProject. |
equals, getFirstDate, getFirstUser, getInternalVersion, getLastDate, getLastUser, hashCode, isNew, preCommit, toString
getGlobalId, getNumericId, hasCustomizedPersistenceMethodFor, invokeCustomizedPersistenceMethodFor
getGlobalId, getNumericId
getFirstDate, getFirstUser, getLastDate, getLastUser
getGlobalId
public static final int CODE_MAX_LENGTH
public static final int NAME_MAX_LENGTH
public static final java.lang.String GLOBAL_PROJECT_PREFIX
public OdiProject(java.lang.String pName, java.lang.String pCode)
pName
- project namepCode
- project codepublic java.util.Collection getVariables()
Obtains the unmodifiable collection of OdiVariable
s.
Use removeVariable(OdiVariable) to remove elements from this collection.
getVariables
in interface IProject
removeVariable(OdiVariable)
public void removeVariable(OdiVariable pVariable)
Remove the given OdiVariable
from the collection of OdiVariable
s.
This will also reset the OdiProject of the given OdiVariable
to null.
pVariable
- an OdiVariable objectDomainRuntimeException
- if pVariable is null or does not belong to this OdiProjectpublic void removeSequence(OdiSequence pSequence)
Remove the given OdiSequence
from the collection of OdiSequence
s.
This will also reset the OdiProject of the given OdiSequence
to null.
pSequence
- an OdiSequence objectDomainRuntimeException
- if pSequence is null or does not belong to this OdiProjectpublic 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 java.util.Collection getFolders()
Obtains the unmodifable collection of OdiFolder
s.
Use removeFolder(OdiFolder) and addFolder(OdiFolder) to respectively add and remove OdiFolder
.
addFolder(OdiFolder)
,
removeFolder(OdiFolder)
public java.util.Collection getMarkerGroups()
public void addFolder(OdiFolder pFolder)
Add the given OdiFolder
to the collection of OdiFolder
s.
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.
pFolder
- an OdiFolder objectDomainRuntimeException
- if pFolder is null or if you try to move this pFolder from an OdiProject to an other.public void removeFolder(OdiFolder pFolder)
Remove the given OdiFolder
from the collection of OdiFolder
s.
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
pFolder
- an OdiFolder objectDomainRuntimeException
- if pFolder is null or does not belong to this OdiProjectpublic java.lang.String getCode()
OdiProject
code. It can't be null, it is uppercase and max length is 35.getCode
in interface IProject
setCode(String)
public void setCode(java.lang.String pCode)
OdiProject
instance. pCode
- a String representing the code valueDomainRuntimeException
- if code is null or empty, is longer than CODE_MAX_LENGTH, is not uppercase, contains whitespacesgetCode()
,
CODE_MAX_LENGTH
public java.lang.String getName()
OdiProject
's name.getName
in interface IFlexFieldUser
getName
in interface IModelObject
getName
in interface IOdiEntity
getName
in class oracle.odi.domain.support.AbstractOdiEntity
setName(java.lang.String)
public void setName(java.lang.String pName)
OdiProject
.
It can't be null or empty and must 35 characters long max.pName
- a String specifying the name valueDomainRuntimeException
- if the name is null, empty or longer than NAME_MAX_LENGTH.getName()
,
NAME_MAX_LENGTH
public java.lang.Number getProjectId()
public java.util.Collection getSequences()
getSequences
in interface IProject
public java.util.Collection getUserFunctions()
getUserFunctions
in interface IProject
public java.util.Collection getIKMs()
OdiProject
.public java.util.Collection getCKMs()
OdiProject
.public java.util.Collection getComponentKMs()
OdiProject
.
Does not return IKMs/LKMs/CKMs.public java.util.Collection getLKMs()
OdiProject
.public java.util.Collection getJKMs()
OdiProject
.public java.util.Collection getRKMs()
OdiProject
.public java.util.Collection getSKMs()
OdiProject
.public java.io.Serializable getInternalId()
IRepositoryEntity
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.
getInternalId
in interface IRepositoryEntity
public void removeCKM(OdiCKM pKM)
Remove the given OdiCKM
from the collection of OdiCKM
s.
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
pKM
- an OdiCKM objectDomainRuntimeException
- if pKM is null or does not belong to this OdiProjectpublic void removeComponentKM(ComponentKM pKM)
Remove the given ComponentKM
from the collection of ComponentKM
s.
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
pKM
- an ComponentKM objectDomainRuntimeException
- if pKM is null or does not belong to this OdiProjectpublic void removeIKM(OdiIKM pKM)
Remove the given OdiIKM
from the collection of OdiIKM
s.
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
pKM
- an OdiIKM objectDomainRuntimeException
- if pKM is null or does not belong to this OdiProjectpublic void removeJKM(OdiJKM pKM)
Remove the given OdiJKM
from the collection of OdiJKM
s.
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
pKM
- an OdiJKM objectDomainRuntimeException
- if pKM is null or does not belong to this OdiProjectpublic void removeLKM(OdiLKM pKM)
Remove the given OdiLKM
from the collection of OdiLKM
s.
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
pKM
- an OdiLKM objectDomainRuntimeException
- if pKM is null or does not belong to this OdiProjectpublic void removeRKM(OdiRKM pKM)
Remove the given OdiRKM
from the collection of OdiRKM
s.
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
pKM
- an OdiRKM objectDomainRuntimeException
- if pKM is null or does not belong to this OdiProject@Deprecated public OdiSKM addSKM(java.lang.String pName)
OdiSKM.OdiSKM(OdiProject pProject, String pName)
pName
- public void removeSKM(OdiSKM pKM)
Remove the given OdiSKM
from the collection of OdiSKM
s.
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
pKM
- an OdiSKM objectDomainRuntimeException
- if pKM is null or does not belong to this OdiProjectpublic boolean supportsImport(java.lang.Class pChildClass)
OdiKM
and its subclasses could be imported to an OdiProject.supportsImport
in interface IImportRoot
pChildClass
- the class of object to be imported into this onetrue
if the given type could be imported, false
otherwiseIImportRoot.supportsImport(java.lang.Class)
public IRepositoryEntity getSecurityContainer()
IRepositoryEntity
getSecurityContainer
in interface IRepositoryEntity
public void removeUserFunction(OdiUserFunction pUserFunction)
OdiUserFunction
from the collection of OdiUserFunction
s.pUserFunction
- - OdiUserFunction
to removeDomainRuntimeException
- if pUserFunction is null or does not belong to this OdiProjectpublic java.util.Collection getFlexFieldsValues()
IFlexFieldUser
.
Method initFlexFields(IOdiFlexFieldFinder)
should be
called first.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 void addComponentKM(IKnowledgeModule compKM)
IProject
addComponentKM
in interface IProject
compKM
- the component KM to be added.public java.util.List getAllKMs()
IProject
public java.util.List getKMs(IKnowledgeModule.KMType type)
IProject