|
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.OdiFolder
public class OdiFolder
An OdiFolder is a workbench entity that ODI users will use to organize their
work related to a single OdiProject
.
Field Summary | |
---|---|
static int |
NAME_MAX_LENGTH
Maximum name length allowed. |
Fields inherited from class oracle.odi.domain.support.AbstractOdiEntity |
---|
STARTING_INTERNAL_VERSION |
Constructor Summary | |
---|---|
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. |
Method Summary | |
---|---|
void |
addInterface(OdiInterface pInterface)
Add the given OdiInterface to the collection of OdiInterface s. |
void |
addPackage(OdiPackage pPackage)
Add the given OdiPackage to the collection of OdiPackage s. |
void |
addSubFolder(OdiFolder pSubFolder)
Add the given OdiFolder to the collection of OdiFolder s. |
void |
addUserProcedure(OdiUserProcedure pUserProcedure)
Add the given OdiUserProcedure to the collection of OdiUserProcedure s. |
java.lang.Number |
getFolderId()
Returns this OdiFolder instance's identifer. |
java.util.Collection<OdiInterface> |
getInterfaces()
Obtains the unmodifable collection of OdiInterface s. |
java.io.Serializable |
getInternalId()
Return this OdiFolder instance's identifier. |
java.lang.String |
getName()
Returns the name of the OdiFolder. |
java.util.Collection<OdiPackage> |
getPackages()
Obtains the unmodifable collection of OdiPackage s. |
OdiFolder |
getParentFolder()
Return the parent OdiFolder of this OdiFolder. |
OdiProject |
getProject()
Returns the parent OdiProject that owns this OdiFolder instance. |
IRepositoryEntity |
getSecurityContainer()
Define a generic way to retrieve container for entities. |
java.util.Collection<OdiFolder> |
getSubFolders()
Obtains the unmodifable collection of OdiFolder s. |
java.util.Collection<OdiUserProcedure> |
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 |
removeInterface(OdiInterface pInterface)
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 |
removeSubFolder(OdiFolder pSubFolder)
Remove the given OdiFolder from the collection of OdiFolder s. |
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. |
boolean |
supportsImport(java.lang.Class<IOdiEntity> pChildClass)
Return true if OdiFolder is root for an import of this class. |
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 OdiFolder(OdiFolder pParentFolder, java.lang.String pName)
pParentFolder
- owning folderpName
- folder name
java.lang.IllegalArgumentException
- if the parent folder is null ; if the name is null, empty or longer than NAME_MAX_LENGTHNAME_MAX_LENGTH
public OdiFolder(OdiProject pProject, java.lang.String pName)
pProject
- owning projectpName
- folder name
java.lang.IllegalArgumentException
- if the project is null ; if the name is null, empty or longer than NAME_MAX_LENGTHOdiProject
,
NAME_MAX_LENGTH
Method Detail |
---|
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 object
java.lang.IllegalArgumentException
- if pInterface is null. TODO other possible cause of this exception (Self association, Scope...)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 object
java.lang.IllegalArgumentException
- if pPackage is null. TODO other possible cause of this exception (Self association, Scope...)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 object
java.lang.IllegalArgumentException
- 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 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 object
java.lang.IllegalArgumentException
- if pUserProcedure is null. TODO other possible cause of this exception (Self association, Scope...)public java.lang.Number getFolderId()
OdiFolder
instance's identifer.
public java.util.Collection<OdiInterface> 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.io.Serializable getInternalId()
OdiFolder
instance's identifier.
getInternalId
in interface IRepositoryEntity
getFolderId()
public java.lang.String getName()
getName
in interface IOdiEntity
getName
in class oracle.odi.domain.support.AbstractOdiEntity
setName(String)
public java.util.Collection<OdiPackage> getPackages()
Obtains the unmodifable collection of OdiPackage
s.
Use removePackage(OdiPackage) and addPackage(OdiPackage) to respectively add and remove OdiPackage
.
addPackage(OdiPackage)
,
removePackage(OdiPackage)
public OdiFolder getParentFolder()
null
if this is a root OdiFolder
of the OdiProject.
public OdiProject getProject()
OdiProject
that owns this OdiFolder
instance.
Return value can't be null.
OdiProject
public IRepositoryEntity getSecurityContainer()
IRepositoryEntity
getSecurityContainer
in interface IRepositoryEntity
public java.util.Collection<OdiFolder> 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 java.util.Collection<OdiUserProcedure> 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 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 object
java.lang.IllegalArgumentException
- if pInterface is null or does not belong to this OdiFolderpublic 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 object
java.lang.IllegalArgumentException
- if pPackage is null or does not belong to this OdiFolderpublic 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 object
java.lang.IllegalArgumentException
- if pSubFolder is null or does not belong to this OdiFolderpublic 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 object
java.lang.IllegalArgumentException
- if pUserProcedure is null or does not belong to this OdiFolderpublic void setName(java.lang.String pName)
OdiFolder
instance.
pName
- folder name
java.lang.IllegalArgumentException
- if the name is null, empty or longer than NAME_MAX_LENGTHNAME_MAX_LENGTH
,
getName()
public boolean supportsImport(java.lang.Class<IOdiEntity> pChildClass)
OdiFolder
is root for an import of this class.
supportsImport
in interface IImportRoot
pChildClass
- Class to check
|
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 |