|
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.model.OdiModelFolder
public class OdiModelFolder
An OdiModelFolder is used to arrange OdiModel
s.
OdiModelFolder allow for hierarchical organization, and an OdiModelFolder can be child of another
parent OdiModelFolder, like OdiFolder
s.
Field Summary | |
---|---|
static int |
NAME_MAX_LENGTH
The maximum length of an OdiModelFolder's name. |
Fields inherited from class oracle.odi.domain.support.AbstractOdiEntity |
---|
STARTING_INTERNAL_VERSION |
Constructor Summary | |
---|---|
OdiModelFolder(OdiModelFolder pParentOdiModelFolder,
java.lang.String pName)
Creates a model folder as a child of the given model folder. |
|
OdiModelFolder(java.lang.String pName)
Creates a "root" model folder. |
Method Summary | |
---|---|
void |
addModel(OdiModel pModel)
Add the given model to the collection of models. |
void |
addModelFolder(OdiModelFolder pModelFolder)
Add the given model folder to the collection of model folders. |
java.lang.String |
getDescription()
Gets the description of this OdiModelFolder instance. |
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.lang.Number |
getModelFolderId()
Returns the internal identifier of this OdiModelFolder instance. |
java.util.Collection<OdiModelFolder> |
getModelFolders()
Obtains the unmodifable collection of model folders for this OdiModelFolder instance. |
java.util.Collection<OdiModel> |
getModels()
Obtains the unmodifable collection of models contained by this OdiModelFolder instance. |
java.lang.String |
getName()
Returns the name of this OdiModelFolder instance. |
OdiModelFolder |
getParentModelFolder()
Returns the parent model folder of this OdiModelFolder instance. |
IRepositoryEntity |
getSecurityContainer()
Define a generic way to retrieve container for entities. |
boolean |
isInstanceLevelSecurityNeeded()
Internal: this method is for internal purpose and must not be considered as part of the public API. |
void |
removeModel(OdiModel pModel)
Remove the given model from the collection of models. |
void |
removeModelFolder(OdiModelFolder pModelFolder)
Remove the given model folder from the collection of model folders. |
void |
setDescription(java.lang.String pDescription)
Sets the description of this OdiModelFolder instance. |
void |
setName(java.lang.String pName)
Sets the name of this OdiModelFolder instance. |
boolean |
supportsImport(java.lang.Class<IOdiEntity> pChildClass)
Returns whether the given entity type is supported to be imported into that root import object. |
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 NAME_MAX_LENGTH
Constructor Detail |
---|
public OdiModelFolder(OdiModelFolder pParentOdiModelFolder, java.lang.String pName)
pParentOdiModelFolder
- parent model folderpName
- model folder name
java.lang.IllegalArgumentException
- if the parent model folder is null ; if the name is null, empty or longer than 400NAME_MAX_LENGTH
public OdiModelFolder(java.lang.String pName)
pName
- model folder name
java.lang.IllegalArgumentException
- if the name is null, empty or longer than 400NAME_MAX_LENGTH
Method Detail |
---|
public void addModel(OdiModel pModel)
This will also set the ParentModelFolder of the given model to this model folder. If the given model was already associated to an other model folder it will be removed from the other model folder.
pModel
- OdiModel object to add to this model folder
java.lang.IllegalArgumentException
- if pModel is null.removeModel(OdiModel)
public void addModelFolder(OdiModelFolder pModelFolder)
This will also set the ParentModelFolder of the given model folder to this model folder. If the given model folder was already associated to an other model folder it will be removed from the other model folder.
pModelFolder
- OdiModelFolder object to add as a child of this
java.lang.IllegalArgumentException
- if pModelFolder is null or if you try to define a cyclic hierarchypublic java.lang.String getDescription()
OdiModelFolder
instance.
setDescription(String)
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.lang.Number getModelFolderId()
OdiModelFolder
instance.
public java.util.Collection<OdiModelFolder> getModelFolders()
OdiModelFolder
instance.
Use removeModelFolder(OdiModelFolder) and addModelFolder(OdiModelFolder) to respectively add and remove model folders.
addModelFolder(OdiModelFolder)
,
removeModelFolder(OdiModelFolder)
public java.util.Collection<OdiModel> getModels()
OdiModelFolder
instance.
Use removeModel(OdiModel) and addModel(OdiModel) respectively to add and remove models.
addModel(OdiModel)
,
removeModel(OdiModel)
public java.lang.String getName()
OdiModelFolder
instance.
getName
in interface IOdiEntity
getName
in class oracle.odi.domain.support.AbstractOdiEntity
setName(String)
public OdiModelFolder getParentModelFolder()
OdiModelFolder
instance.
pParentModelFolder may be null if this a root folder.
setParentModelFolder(OdiModelFolder)
public IRepositoryEntity getSecurityContainer()
IRepositoryEntity
getSecurityContainer
in interface IRepositoryEntity
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 removeModel(OdiModel pModel)
This will also reset the ParentModelFolder of the given model to null making the given model a root.
Note: IOdiEntityManager.remove(pModel) must also be called in order to remove the model from the repository
pModel
- OdiModel object to remove from this model folder
java.lang.IllegalArgumentException
- if pModel is null or does not belong to this OdiModelFolderaddModel(OdiModel)
public void removeModelFolder(OdiModelFolder pModelFolder)
This will also reset the ParentModelFolder of the given model folder to null making the given model folder a root.
Note: IOdiEntityManager.remove(pModelFolder) must also be called in order to remove the model folder from the repository
pModelFolder
- OdiModelFolder object to remove from this model folder
java.lang.IllegalArgumentException
- if pModelFolder is null or does not belong to this OdiModelFolderpublic void setDescription(java.lang.String pDescription)
OdiModelFolder
instance.
pDescription
- descriptiongetDescription()
public void setName(java.lang.String pName)
OdiModelFolder
instance.
pName
- model folder name
java.lang.IllegalArgumentException
- if the name is null, empty or longer than 400NAME_MAX_LENGTH
,
getName()
public boolean supportsImport(java.lang.Class<IOdiEntity> pChildClass)
IImportRoot
supportsImport
in interface IImportRoot
pChildClass
- the class of object to be imported into this one
true
if the given type could be imported, false
otherwise
|
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 |