oracle.odi.domain.project
Class OdiFolder

java.lang.Object
  oracle.odi.domain.support.BusinessObject
      oracle.odi.domain.support.AbstractRepositoryEntity
          oracle.odi.domain.support.AbstractOdiEntity
              oracle.odi.domain.project.OdiFolder

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, IExportable, IImportRoot, IOdiEntity, IRepositoryEntity, IWorkDevelopmentOdiEntity, IOdiScenarioSourceContainer

public class OdiFolder
extends oracle.odi.domain.support.AbstractOdiEntity
implements IOdiScenarioSourceContainer, IWorkDevelopmentOdiEntity, IExportable, IImportRoot

An OdiFolder is a workbench entity that ODI users will use to organize their work related to a single OdiProject.

Since:

11.1.1.3.0

See Also:

Serialized Form

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 OdiInterfaces.
void	addPackage(OdiPackage pPackage) Add the given OdiPackage to the collection of OdiPackages.
void	addSubFolder(OdiFolder pSubFolder) Add the given OdiFolder to the collection of OdiFolders.
void	addUserProcedure(OdiUserProcedure pUserProcedure) Add the given OdiUserProcedure to the collection of OdiUserProcedures.
java.lang.Number	getFolderId() Returns this OdiFolder instance's identifer.
java.util.Collection<OdiInterface>	getInterfaces() Obtains the unmodifable collection of OdiInterfaces.
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 OdiPackages.
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 OdiFolders.
java.util.Collection<OdiUserProcedure>	getUserProcedures() Obtains the unmodifable collection of OdiUserProcedures.
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 OdiInterfaces.
void	removePackage(OdiPackage pPackage) Remove the given OdiPackage from the collection of OdiPackages.
void	removeSubFolder(OdiFolder pSubFolder) Remove the given OdiFolder from the collection of OdiFolders.
void	removeUserProcedure(OdiUserProcedure pUserProcedure) Remove the given OdiUserProcedure from the collection of OdiUserProcedures.
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

NAME_MAX_LENGTH

public static final int NAME_MAX_LENGTH

Maximum name length allowed.

See Also:

Constant Field Values

Constructor Detail

OdiFolder

public OdiFolder(OdiFolder pParentFolder,
                 java.lang.String pName)

Constructor who sets parent folder and the name of the folder.

Parameters:

pParentFolder - owning folder

pName - folder name

Throws:

java.lang.IllegalArgumentException - if the parent folder is null ; if the name is null, empty or longer than NAME_MAX_LENGTH

See Also:

NAME_MAX_LENGTH

OdiFolder

public OdiFolder(OdiProject pProject,
                 java.lang.String pName)

Constructor who sets the parent project and the name of the folder.

Parameters:

pProject - owning project

pName - folder name

Throws:

java.lang.IllegalArgumentException - if the project is null ; if the name is null, empty or longer than NAME_MAX_LENGTH

See Also:

OdiProject, NAME_MAX_LENGTH

Method Detail

addInterface

public void addInterface(OdiInterface pInterface)

Add the given OdiInterface to the collection of OdiInterfaces.

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.

Parameters:

pInterface - an OdiInterface object

Throws:

java.lang.IllegalArgumentException - if pInterface is null. TODO other possible cause of this exception (Self association, Scope...)

addPackage

public void addPackage(OdiPackage pPackage)

Add the given OdiPackage to the collection of OdiPackages.

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.

Parameters:

pPackage - an OdiPackage object

Throws:

java.lang.IllegalArgumentException - if pPackage is null. TODO other possible cause of this exception (Self association, Scope...)

addSubFolder

public void addSubFolder(OdiFolder pSubFolder)

Add the given OdiFolder to the collection of OdiFolders.

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.

Parameters:

pSubFolder - an OdiFolder object

Throws:

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.

addUserProcedure

public void addUserProcedure(OdiUserProcedure pUserProcedure)

Add the given OdiUserProcedure to the collection of OdiUserProcedures.

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.

Parameters:

pUserProcedure - an OdiUserProcedure object

Throws:

java.lang.IllegalArgumentException - if pUserProcedure is null. TODO other possible cause of this exception (Self association, Scope...)

getFolderId

public java.lang.Number getFolderId()

Returns this OdiFolder instance's identifer.

Returns:

a Number object representing the folder id value

getInterfaces

public java.util.Collection<OdiInterface> getInterfaces()

Obtains the unmodifable collection of OdiInterfaces.

Use removeInterface(OdiInterface) and addInterface(OdiInterface) to respectively add and remove OdiInterface.

Returns:

a Collection object representing the interfaces value

See Also:

addInterface(OdiInterface), removeInterface(OdiInterface)

getInternalId

public java.io.Serializable getInternalId()

Return this OdiFolder instance's identifier.

Specified by:

getInternalId in interface IRepositoryEntity

Returns:

the persistence identity of this instance

See Also:

getFolderId()

getName

public java.lang.String getName()

Returns the name of the OdiFolder. Can't be null or empty.

Specified by:

getName in interface IOdiEntity

Overrides:

getName in class oracle.odi.domain.support.AbstractOdiEntity

Returns:

String

See Also:

setName(String)

getPackages

public java.util.Collection<OdiPackage> getPackages()

Obtains the unmodifable collection of OdiPackages.

Use removePackage(OdiPackage) and addPackage(OdiPackage) to respectively add and remove OdiPackage.

Returns:

a Collection object representing the packages value

See Also:

addPackage(OdiPackage), removePackage(OdiPackage)

getParentFolder

public OdiFolder getParentFolder()

Return the parent OdiFolder of this OdiFolder. null if this is a root OdiFolder of the OdiProject.

Returns:

an OdiFolder object representing the parent folder value

getProject

public OdiProject getProject()

Returns the parent OdiProject that owns this OdiFolder instance. Return value can't be null.

Returns:

OdiProject

getSecurityContainer

public IRepositoryEntity getSecurityContainer()

Description copied from interface: IRepositoryEntity

Define a generic way to retrieve container for entities.

Specified by:

getSecurityContainer in interface IRepositoryEntity

Returns:

container entity

getSubFolders

public java.util.Collection<OdiFolder> getSubFolders()

Obtains the unmodifable collection of OdiFolders.

Use removeSubFolder(OdiFolder) and addSubFolder(OdiFolder) to respectively add and remove OdiFolder.

Returns:

a Collection object representing the sub folders value

See Also:

addSubFolder(OdiFolder), removeSubFolder(OdiFolder)

getUserProcedures

public java.util.Collection<OdiUserProcedure> getUserProcedures()

Obtains the unmodifable collection of OdiUserProcedures.

Use removeUserProcedure(OdiUserProcedure) and addUserProcedure(OdiUserProcedure) to respectively add and remove OdiUserProcedure.

Returns:

a Collection object representing the user procedures value

See Also:

addUserProcedure(OdiUserProcedure), removeUserProcedure(OdiUserProcedure)

isInstanceLevelSecurityNeeded

public boolean isInstanceLevelSecurityNeeded()

Description copied from interface: IOdiEntity

Internal: this method is for internal purpose and must not be considered as part of the public API.

Defines a method to capture the info on which object needs instance level privilege.

Specified by:

isInstanceLevelSecurityNeeded in interface IOdiEntity

Overrides:

isInstanceLevelSecurityNeeded in class oracle.odi.domain.support.AbstractOdiEntity

Returns:

true if instance level security needed, false otherwise

removeInterface

public void removeInterface(OdiInterface pInterface)

Remove the given OdiInterface from the collection of OdiInterfaces.

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

Parameters:

pInterface - an OdiInterface object

Throws:

java.lang.IllegalArgumentException - if pInterface is null or does not belong to this OdiFolder

removePackage

public void removePackage(OdiPackage pPackage)

Remove the given OdiPackage from the collection of OdiPackages.

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

Parameters:

pPackage - an OdiPackage object

Throws:

java.lang.IllegalArgumentException - if pPackage is null or does not belong to this OdiFolder

removeSubFolder

public void removeSubFolder(OdiFolder pSubFolder)

Remove the given OdiFolder from the collection of OdiFolders.

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

Parameters:

pSubFolder - an OdiFolder object

Throws:

java.lang.IllegalArgumentException - if pSubFolder is null or does not belong to this OdiFolder

removeUserProcedure

public void removeUserProcedure(OdiUserProcedure pUserProcedure)

Remove the given OdiUserProcedure from the collection of OdiUserProcedures.

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

Parameters:

pUserProcedure - an OdiUserProcedure object

Throws:

java.lang.IllegalArgumentException - if pUserProcedure is null or does not belong to this OdiFolder

setName

public 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.

Parameters:

pName - folder name

Throws:

java.lang.IllegalArgumentException - if the name is null, empty or longer than NAME_MAX_LENGTH

See Also:

NAME_MAX_LENGTH, getName()

supportsImport

public boolean supportsImport(java.lang.Class<IOdiEntity> pChildClass)

Return true if OdiFolder is root for an import of this class.

Specified by:

supportsImport in interface IImportRoot

Parameters:

pChildClass - Class to check

Returns:

true if OdiFolder is a parent of pChildClass for import purposes