|
Oracle® Data Integrator Java API Reference 11g Release 1 (11.1.1.3.0) E17060-01 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object oracle.odi.domain.support.BusinessObject oracle.odi.domain.support.AbstractRepositoryEntity oracle.odi.domain.support.AbstractOdiEntity oracle.odi.domain.project.OdiProject
public class OdiProject
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.
Field Summary | |
---|---|
static int |
CODE_MAX_LENGTH
Maximum length of an Odi Project's code. |
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 OdiFolder s. |
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<OdiFolder> |
getFolders()
Obtains the unmodifable collection of OdiFolder s. |
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 OdiVariable s.Use removeVariable(OdiVariable) to remove elements from this collection. |
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 OdiCKM s. |
void |
removeFolder(OdiFolder pFolder)
Remove the given OdiFolder from the collection of OdiFolder s. |
void |
removeIKM(OdiIKM pKM)
Remove the given OdiIKM from the collection of OdiIKM s. |
void |
removeJKM(OdiJKM pKM)
Remove the given OdiJKM from the collection of OdiJKM s. |
void |
removeLKM(OdiLKM pKM)
Remove the given OdiLKM from the collection of OdiLKM s. |
void |
removeRKM(OdiRKM pKM)
Remove the given OdiRKM from the collection of OdiRKM s. |
void |
removeSequence(OdiSequence pSequence)
Remove the given OdiSequence from the collection of OdiSequence s. |
void |
removeSKM(OdiSKM pKM)
Remove the given OdiSKM from the collection of OdiSKM 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<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 |
---|
public static final int CODE_MAX_LENGTH
public static final int NAME_MAX_LENGTH
Constructor Detail |
---|
public OdiProject(java.lang.String pName, java.lang.String pCode)
pName
- project namepCode
- project codeMethod Detail |
---|
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 object
java.lang.IllegalArgumentException
- if pFolder is null or if you try to move this pFolder from an OdiProject to an other.public java.util.Collection<OdiCKM> getCKMs()
OdiProject
.
public java.lang.String getCode()
OdiProject
code. It can't be null, it is uppercase and max length is 35.
setCode(String)
public java.util.Collection<OdiFolder> 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<OdiIKM> getIKMs()
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 java.util.Collection<OdiJKM> getJKMs()
OdiProject
.
public java.util.Collection<OdiLKM> getLKMs()
OdiProject
.
public java.lang.String getName()
OdiProject
's name.
getName
in interface IOdiEntity
getName
in class oracle.odi.domain.support.AbstractOdiEntity
setName(java.lang.String)
public java.lang.Number getProjectId()
public java.util.Collection<OdiRKM> getRKMs()
OdiProject
.
public IRepositoryEntity getSecurityContainer()
IRepositoryEntity
getSecurityContainer
in interface IRepositoryEntity
public java.util.Collection<OdiSequence> getSequences()
public java.util.Collection<OdiSKM> getSKMs()
OdiProject
.
public java.util.Collection<OdiUserFunction> getUserFunctions()
public java.util.Collection<OdiVariable> getVariables()
Obtains the unmodifable collection of OdiVariable
s.
Use removeVariable(OdiVariable) to remove elements from this collection.
removeVariable(OdiVariable)
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 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 object
java.lang.IllegalArgumentException
- if pKM is null or does not belong to this OdiProjectpublic 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 object
java.lang.IllegalArgumentException
- if pFolder 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 object
java.lang.IllegalArgumentException
- 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 object
java.lang.IllegalArgumentException
- 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 object
java.lang.IllegalArgumentException
- 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 object
java.lang.IllegalArgumentException
- if pKM 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 object
java.lang.IllegalArgumentException
- if pSequence is null or does not belong to this OdiProjectpublic 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 object
java.lang.IllegalArgumentException
- if pKM is null or does not belong to this OdiProjectpublic 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 object
java.lang.IllegalArgumentException
- if pVariable is null or does not belong to this OdiProjectpublic void setCode(java.lang.String pCode)
OdiProject
instance.
pCode
- a String representing the code value
java.lang.IllegalArgumentException
- if code is null or empty, is longer than CODE_MAX_LENGTH, is not uppercase, contains whitespacesgetCode()
,
CODE_MAX_LENGTH
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 value
java.lang.IllegalArgumentException
- if the name is null, empty or longer than NAME_MAX_LENGTH.getName()
,
NAME_MAX_LENGTH
public boolean supportsImport(java.lang.Class<IOdiEntity> 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 one
true
if the given type could be imported, false
otherwiseIImportRoot.supportsImport(java.lang.Class)
|
Oracle® Data Integrator Java API Reference 11g Release 1 (11.1.1.3.0) E17060-01 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |