oracle.odi.domain.model
Class OdiModelFolder

java.lang.Object
  oracle.odi.domain.support.BusinessObject
      oracle.odi.domain.support.AbstractRepositoryEntity
          oracle.odi.domain.support.AbstractOdiEntity
              oracle.odi.domain.model.OdiModelFolder

All Implemented Interfaces:

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

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

An OdiModelFolder is used to arrange OdiModels.

OdiModelFolder allow for hierarchical organization, and an OdiModelFolder can be child of another parent OdiModelFolder, like OdiFolders.

Since:

11.1.1.3.0

See Also:

Serialized Form

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

NAME_MAX_LENGTH

public static final int NAME_MAX_LENGTH

The maximum length of an OdiModelFolder's name.

See Also:

Constant Field Values

Constructor Detail

OdiModelFolder

public OdiModelFolder(OdiModelFolder pParentOdiModelFolder,
                      java.lang.String pName)

Creates a model folder as a child of the given model folder.

Parameters:

pParentOdiModelFolder - parent model folder

pName - model folder name

Throws:

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

See Also:

NAME_MAX_LENGTH

OdiModelFolder

public OdiModelFolder(java.lang.String pName)

Creates a "root" model folder.

Parameters:

pName - model folder name

Throws:

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

See Also:

NAME_MAX_LENGTH

Method Detail

addModel

public void addModel(OdiModel pModel)

Add the given model to the collection of models.

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.

Parameters:

pModel - OdiModel object to add to this model folder

Throws:

java.lang.IllegalArgumentException - if pModel is null.

See Also:

removeModel(OdiModel)

addModelFolder

public void addModelFolder(OdiModelFolder pModelFolder)

Add the given model folder to the collection of model folders.

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.

Parameters:

pModelFolder - OdiModelFolder object to add as a child of this

Throws:

java.lang.IllegalArgumentException - if pModelFolder is null or if you try to define a cyclic hierarchy

getDescription

public java.lang.String getDescription()

Gets the description of this OdiModelFolder instance.

Returns:

a String representing the description value

See Also:

setDescription(String)

getInternalId

public java.io.Serializable getInternalId()

Description copied from interface: IRepositoryEntity

Provides a common getter for the persistence layer to obtain an identity, irrespective of the actual type of identity used.

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.

Specified by:

getInternalId in interface IRepositoryEntity

Returns:

the persistence identity of this instance

getModelFolderId

public java.lang.Number getModelFolderId()

Returns the internal identifier of this OdiModelFolder instance.

Returns:

a Number object representing the model folder id value

getModelFolders

public java.util.Collection<OdiModelFolder> getModelFolders()

Obtains the unmodifable collection of model folders for this OdiModelFolder instance.

Use removeModelFolder(OdiModelFolder) and addModelFolder(OdiModelFolder) to respectively add and remove model folders.

Returns:

collection of OdiModelFolder

See Also:

addModelFolder(OdiModelFolder), removeModelFolder(OdiModelFolder)

getModels

public java.util.Collection<OdiModel> getModels()

Obtains the unmodifable collection of models contained by this OdiModelFolder instance.

Use removeModel(OdiModel) and addModel(OdiModel) respectively to add and remove models.

Returns:

collection of OdiModels.

See Also:

addModel(OdiModel), removeModel(OdiModel)

getName

public java.lang.String getName()

Returns the name of this OdiModelFolder instance.

Specified by:

getName in interface IOdiEntity

Overrides:

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

Returns:

the name

See Also:

setName(String)

getParentModelFolder

public OdiModelFolder getParentModelFolder()

Returns the parent model folder of this OdiModelFolder instance.

pParentModelFolder may be null if this a root folder.

Returns:

parent model folder or null if none

See Also:

setParentModelFolder(OdiModelFolder)

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

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

removeModel

public void removeModel(OdiModel pModel)

Remove the given model from the collection of models.

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

Parameters:

pModel - OdiModel object to remove from this model folder

Throws:

java.lang.IllegalArgumentException - if pModel is null or does not belong to this OdiModelFolder

See Also:

addModel(OdiModel)

removeModelFolder

public void removeModelFolder(OdiModelFolder pModelFolder)

Remove the given model folder from the collection of model folders.

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

Parameters:

pModelFolder - OdiModelFolder object to remove from this model folder

Throws:

java.lang.IllegalArgumentException - if pModelFolder is null or does not belong to this OdiModelFolder

setDescription

public void setDescription(java.lang.String pDescription)

Sets the description of this OdiModelFolder instance.

Parameters:

pDescription - description

See Also:

getDescription()

setName

public void setName(java.lang.String pName)

Sets the name of this OdiModelFolder instance.

Parameters:

pName - model folder name

Throws:

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

See Also:

NAME_MAX_LENGTH, getName()

supportsImport

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

Description copied from interface: IImportRoot

Returns whether the given entity type is supported to be imported into that root import object.

Specified by:

supportsImport in interface IImportRoot

Parameters:

pChildClass - the class of object to be imported into this one

Returns:

true if the given type could be imported, false otherwise