public class OdiFolder extends oracle.odi.domain.support.AbstractOdiEntity implements IFolder, IOdiScenarioSourceContainer, IWorkDevelopmentOdiEntity, oracle.odi.domain.impexp.IExportable, IImportRoot, oracle.odi.impexp.smartie.ISmartExportable
OdiProject
.Modifier and Type | Class and Description |
---|---|
class |
OdiFolder.ReleaseTag |
Modifier and Type | Field and Description |
---|---|
static int |
NAME_MAX_LENGTH
Maximum name length allowed.
|
Constructor and Description |
---|
OdiFolder(OdiFolder pParentFolder,
java.lang.String pName)
Constructor who sets parent folder and the name of the folder.
|
OdiFolder(OdiProject pProject,
java.lang.String pName)
Constructor who sets the parent project and the name of the folder.
|
Modifier and Type | Method and Description |
---|---|
void |
addInterface(OdiInterface pInterface)
Add the given
OdiInterface to the collection of OdiInterface s. |
void |
addMapping(Mapping pMapping)
|
void |
addPackage(OdiPackage pPackage)
Add the given
OdiPackage to the collection of OdiPackage s. |
void |
addReusableMapping(ReusableMapping pReusableMapping)
Adds a reusable mapping to this folder.
|
void |
addSubFolder(OdiFolder pSubFolder)
|
void |
addUserProcedure(OdiUserProcedure pUserProcedure)
Add the given
OdiUserProcedure to the collection of OdiUserProcedure s. |
Mapping |
findMapping(java.lang.String name)
Finds a mapping owned by this folder, given a mapping name.
|
ReusableMapping |
findReusableMapping(java.lang.String name)
Finds a reusable mapping in this folder, given a mapping name.
|
java.util.List |
getChildren() |
java.lang.Number |
getFolderId()
Returns this
OdiFolder instance's identifier. |
java.util.Collection |
getInterfaces()
Obtains the unmodifable collection of
OdiInterface s. |
java.io.Serializable |
getInternalId()
Return this
OdiFolder instance's identifier. |
java.util.List |
getMappings()
Gets a list of mappings owned by this folder.
|
java.lang.String |
getName()
Returns the name of the OdiFolder.
|
java.util.Collection |
getPackages()
Obtains the unmodifiable collection of
OdiPackage s. |
OdiFolder |
getParentFolder()
Return the parent OdiFolder of this OdiFolder.
|
OdiProject |
getProject()
Returns the parent
OdiProject that owns this OdiFolder instance. |
IReleaseTag |
getReleaseTag()
Get the
IReleaseTag object. |
java.util.List |
getReusableMappings()
Gets a list of reusable mappings owned by this folder.
|
IRepositoryEntity |
getSecurityContainer()
Define a generic way to retrieve container for entities.
|
java.util.Collection |
getSubFolders()
Obtains the unmodifable collection of
OdiFolder s. |
java.util.Collection |
getUserProcedures()
Obtains the unmodifable collection of
OdiUserProcedure s. |
boolean |
isInstanceLevelSecurityNeeded()
Internal: this method is for internal purpose and must not be considered
as part of the public API.
|
void |
refreshIMapping(IMapping pMapping)
Refresh mapping list with given Mapping object.
|
void |
refreshReusableMapping(ReusableMapping pReusableMapping)
Refresh reusable mapping list with given ReusableMapping object.
|
void |
removeInterface(OdiInterface pInterface)
Remove the given
OdiInterface from the collection of OdiInterface s. |
void |
removeMapping(Mapping pMapping)
Remove the given
OdiInterface from the collection of OdiInterface s. |
void |
removePackage(OdiPackage pPackage)
Remove the given
OdiPackage from the collection of OdiPackage s. |
void |
removeReusableMapping(ReusableMapping pReusableMapping)
Removes a reusable mapping from this folder.
|
void |
removeSubFolder(OdiFolder pSubFolder)
|
void |
removeUserProcedure(OdiUserProcedure pUserProcedure)
Remove the given
OdiUserProcedure from the collection of OdiUserProcedure s. |
void |
setName(java.lang.String pName)
Sets the name of this
OdiFolder instance.pName must 400 characters long max. Can't be null or empty. |
void |
setReleaseTag(IReleaseTag pReleaseTag)
Set the
IReleaseTag object. |
boolean |
supportsImport(java.lang.Class pChildClass)
Return true if
OdiFolder is root for an import of this class. |
equals, getFirstDate, getFirstUser, getInternalVersion, getLastDate, getLastUser, hashCode, isNew, toString
getGlobalId, getNumericId, hasCustomizedPersistenceMethodFor, invokeCustomizedPersistenceMethodFor
getGlobalId, getNumericId
getFirstDate, getFirstUser, getLastDate, getLastUser
getGlobalId
public static final int NAME_MAX_LENGTH
public OdiFolder(OdiProject pProject, java.lang.String pName)
pProject
- owning projectpName
- folder nameDomainRuntimeException
- if the project is null ; if the name is null, empty or longer than NAME_MAX_LENGTHOdiProject
,
NAME_MAX_LENGTH
public OdiFolder(OdiFolder pParentFolder, java.lang.String pName)
pParentFolder
- owning folderpName
- folder nameDomainRuntimeException
- if the parent folder is null ; if the name is null, empty or longer than NAME_MAX_LENGTHNAME_MAX_LENGTH
public java.util.Collection getUserProcedures()
Obtains the unmodifable collection of OdiUserProcedure
s.
Use removeUserProcedure(OdiUserProcedure) and addUserProcedure(OdiUserProcedure) to respectively add and remove OdiUserProcedure
.
addUserProcedure(OdiUserProcedure)
,
removeUserProcedure(OdiUserProcedure)
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 addUserProcedure(OdiUserProcedure pUserProcedure)
Add the given OdiUserProcedure
to the collection of OdiUserProcedure
s.
This will also set the Folder of the given OdiUserProcedure
to this OdiFolder instance.
If the given OdiUserProcedure
was already associated to an other OdiFolder it will be removed from this one.
pUserProcedure
- an OdiUserProcedure objectDomainRuntimeException
- if pUserProcedure is null. TODO other possible cause of this exception (Self association, Scope...)public void removeUserProcedure(OdiUserProcedure pUserProcedure)
Remove the given OdiUserProcedure
from the collection of OdiUserProcedure
s.
This will also reset the OdiFolder of the given OdiUserProcedure
to null.
Note: you will have to call IOdiEntityManager.remove(pUserProcedure) too in order to really remove the OdiUserProcedure
pUserProcedure
- an OdiUserProcedure objectDomainRuntimeException
- if pUserProcedure is null or does not belong to this OdiFolderpublic java.util.Collection getSubFolders()
Obtains the unmodifable collection of OdiFolder
s.
Use removeSubFolder(OdiFolder) and addSubFolder(OdiFolder) to respectively add and remove OdiFolder
.
addSubFolder(OdiFolder)
,
removeSubFolder(OdiFolder)
public void addSubFolder(OdiFolder pSubFolder)
Add the given OdiFolder
to the collection of OdiFolder
s.
This will also set the ParentFolder of the given OdiFolder
to this OdiFolder instance.
If the given OdiFolder
was already associated to an other OdiFolder it will be removed from this one.
pSubFolder
- an OdiFolder objectDomainRuntimeException
- if pSubFolder is null or if you try to define cycle in OdiFolder hierarchy or you try to move an OdiFolder from a Project to an other.public void removeSubFolder(OdiFolder pSubFolder)
Remove the given OdiFolder
from the collection of OdiFolder
s.
This will also reset the OdiFolder of the given OdiFolder
to null making the given OdiFolder
a root OdiFolder
.
Note: You will have to call IOdiEntityManager.remove(pSubFolder) too in order to remove the OdiFolder
from the repository
pSubFolder
- an OdiFolder objectDomainRuntimeException
- if pSubFolder is null or does not belong to this OdiFolderpublic java.util.Collection getInterfaces()
Obtains the unmodifable collection of OdiInterface
s.
Use removeInterface(OdiInterface) and addInterface(OdiInterface) to respectively add and remove OdiInterface
.
addInterface(OdiInterface)
,
removeInterface(OdiInterface)
public java.util.List getMappings()
IFolder
getMappings
in interface IFolder
public void addInterface(OdiInterface pInterface)
Add the given OdiInterface
to the collection of OdiInterface
s.
This will also set the Folder of the given OdiInterface
to this OdiFolder instance.
If the given OdiInterface
was already associated to an other OdiFolder it will be removed from this one.
pInterface
- an OdiInterface objectDomainRuntimeException
- if pInterface is null. TODO other possible cause of this exception (Self association, Scope...)public void removeInterface(OdiInterface pInterface)
Remove the given OdiInterface
from the collection of OdiInterface
s.
This will also reset the OdiFolder of the given OdiInterface
to null.
Note: you will have to call IOdiEntityManager.remove(pInterface) too in order to really remove the OdiInterface
pInterface
- an OdiInterface objectDomainRuntimeException
- if pInterface is null or does not belong to this OdiFolderpublic void addMapping(Mapping pMapping)
Add the given Mapping
to the collection of Mapping
s.
This will also set the Folder of the given Mapping
to this OdiFolder instance.
If the given Mapping
was already associated to an other OdiFolder it will be removed from this one.
addMapping
in interface IFolder
pMapping
- a Mapping objectDomainRuntimeException
- if pMapping is null. TODO other possible cause of this exception (Self association, Scope...)public void removeMapping(Mapping pMapping)
Remove the given OdiInterface
from the collection of OdiInterface
s.
This will also reset the OdiFolder of the given OdiInterface
to null.
Note: you will have to call IOdiEntityManager.remove(pInterface) too in order to really remove the OdiInterface
removeMapping
in interface IFolder
pMapping
- an OdiInterface objectDomainRuntimeException
- if pInterface is null or does not belong to this OdiFolderpublic void refreshIMapping(IMapping pMapping)
pMapping
- public void setName(java.lang.String pName)
OdiFolder
instance.pName
- folder nameDomainRuntimeException
- if the name is null, empty or longer than NAME_MAX_LENGTHNAME_MAX_LENGTH
,
getName()
public java.lang.String getName()
getName
in interface IModelObject
getName
in interface IOdiEntity
getName
in class oracle.odi.domain.support.AbstractOdiEntity
setName(String)
public OdiProject getProject()
OdiProject
that owns this OdiFolder
instance.
Return value can't be null.getProject
in interface IFolder
OdiProject
public java.io.Serializable getInternalId()
OdiFolder
instance's identifier.getInternalId
in interface IRepositoryEntity
getFolderId()
public java.lang.Number getFolderId()
OdiFolder
instance's identifier.public java.util.Collection getPackages()
Obtains the unmodifiable collection of OdiPackage
s.
Use removePackage(OdiPackage) and addPackage(OdiPackage) to respectively add and remove OdiPackage
.
addPackage(OdiPackage)
,
removePackage(OdiPackage)
public void addPackage(OdiPackage pPackage)
Add the given OdiPackage
to the collection of OdiPackage
s.
This will also set the ParentFolder of the given OdiPackage
to this OdiFolder instance.
If the given OdiPackage
was already associated to an other OdiFolder it will be removed from this one.
pPackage
- an OdiPackage objectDomainRuntimeException
- if pPackage is null. TODO other possible cause of this exception (Self association, Scope...)public void removePackage(OdiPackage pPackage)
Remove the given OdiPackage
from the collection of OdiPackage
s.
This will also reset the OdiFolder of the given OdiPackage
to null.
Note: you will have to call IOdiEntityManager.remove(pPackage) too in order to really remove the OdiPackage
pPackage
- an OdiPackage objectDomainRuntimeException
- if pPackage is null or does not belong to this OdiFolderpublic IRepositoryEntity getSecurityContainer()
IRepositoryEntity
getSecurityContainer
in interface IRepositoryEntity
public OdiFolder getParentFolder()
null
if this is a root OdiFolder
of the OdiProject.public boolean supportsImport(java.lang.Class pChildClass)
OdiFolder
is root for an import of this class.supportsImport
in interface IImportRoot
pChildClass
- Class to checkpublic void setReleaseTag(IReleaseTag pReleaseTag)
IReleaseTag
object.
The release tag associated models and folders participating in the same release. IReleaseTag.getValue() == null implies that the release tag is not set.
This will actually set the values of the the release tag. Passing in a null will set the value of this release tag to null.
pReleaseTag
- getReleaseTag()
public IReleaseTag getReleaseTag()
IReleaseTag
object.
The release tag associated models and folders participating in the same release. IReleaseTag.getValue() == null implies that the release tag is not set.
getReleaseTag
in interface IFolder
setReleaseTag(oracle.odi.domain.IReleaseTag)
public java.util.List getChildren()
getChildren
in interface IContainer
public Mapping findMapping(java.lang.String name)
IFolder
findMapping
in interface IFolder
name
- name of the mapping to find.public java.util.List getReusableMappings()
IFolder
getReusableMappings
in interface IFolder
public void removeReusableMapping(ReusableMapping pReusableMapping)
IFolder
removeReusableMapping
in interface IFolder
pReusableMapping
- reusable mapping to remove.public void addReusableMapping(ReusableMapping pReusableMapping)
IFolder
addReusableMapping
in interface IFolder
pReusableMapping
- reusable mapping to add to this folder.public void refreshReusableMapping(ReusableMapping pReusableMapping)
pReusableMapping
- public ReusableMapping findReusableMapping(java.lang.String name)
IFolder
findReusableMapping
in interface IFolder
name
- name of reusable mapping to find.