oracle.odi.domain.runtime.scenario

Class OdiScenarioFolder

java.lang.Object

oracle.odi.domain.support.BusinessObject

oracle.odi.domain.support.AbstractRepositoryEntity

oracle.odi.domain.support.AbstractOdiEntity

oracle.odi.domain.runtime.scenario.OdiScenarioFolder

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, oracle.odi.core.audit.support.IAuditableFirstClassObject, oracle.odi.domain.impexp.IExportable, IOdiEntity, IRepositoryEntity, IWorkRuntimeOdiEntity, oracle.odi.impexp.smartie.ISmartExportable

public final class OdiScenarioFolder
extends oracle.odi.domain.support.AbstractOdiEntity
implements oracle.odi.domain.impexp.IExportable, IWorkRuntimeOdiEntity, oracle.odi.impexp.smartie.ISmartExportable, oracle.odi.core.audit.support.IAuditableFirstClassObject

*

An OdiScenarioFolder is a group of OdiScenarios. It can contain sub-folders. As any folder it has the particularity to be root of its own aggregate and to control removal of every objects that has been defined in it (OdiScenarios as well as sub OdiScenarioFolders).

Life cycle begins when a user create an OdiScenarioFolder inside runtime repository. Once created, user can change its name, description and add or move some OdiScenarios and other OdiScenarioFolders. Life cycle ends when a user removes OdiScenarioFolder from runtime repository. When removed, every OdiScenario and OdiScenarioFolder (sub-folders) that have been moved in this OdiScenarioFolder are also removed.

Since:

11.1.1.3.0

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static int	NAME_MAX_LENGTH Maximum name length allowed.

Fields inherited from class oracle.odi.domain.support.AbstractOdiEntity

STARTING_INTERNAL_VERSION

Constructor Summary

Constructors

Constructor and Description
OdiScenarioFolder(OdiScenarioFolder pParentScenFolder, java.lang.String pName) Constructs the OdiScenarioFolder specified by the given name within the given parent scenario folder.
OdiScenarioFolder(java.lang.String pName) Constructs the top-level OdiScenarioFolder specified by the given name.

Method Summary

Modifier and Type	Method and Description
void	addLoadPlan(OdiLoadPlan pLoadPlan) Add the given OdiLoadPlan to this OdiScenarioFolder.
void	addScenario(OdiScenario pScenario) Add the given OdiScenario to this OdiScenarioFolder.
void	addSubFolder(OdiScenarioFolder pSubScenFolder) Add the given OdiScenarioFolder to this OdiScenarioFolder's hierarchy as a direct child.
java.lang.String	getDescription() Gets description of this OdiScenarioFolder.
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.util.Collection	getLoadPlans() Gets an unmodifiable collection of OdiLoadPlan that belongs to this OdiScenarioFolder.
java.lang.String	getName() Gets name of this OdiScenarioFolder.
OdiScenarioFolder	getParentScenFolder() Returns the parent OdiScenarioFolder of this OdiScenarioFolder or null if this is a root OdiScenarioFolder.
java.lang.Number	getScenarioFolderId() Returns the unique ID of the scenario folder.
java.util.Collection	getScenarios() Gets an unmodifiable collection of OdiScenarios that belongs to this OdiScenarioFolder.
java.util.Collection	getSubFolders() Gets an unmodifiable collection of sub-folders of this OdiScenarioFolder.
boolean	isInstanceLevelSecurityNeeded() Internal: this method is for internal purpose and must not be considered as part of the public API.
void	removeLoadPlan(OdiLoadPlan pLoadPlan) Removes the given OdiLoadPlan from this OdiScenarioFolder's hierarchy.
void	removeScenario(OdiScenario pScenario) Removes the given OdiScenario from this OdiScenarioFolder's hierarchy.
void	removeSubFolder(OdiScenarioFolder pSubScenFolder) Removes the given OdiScenarioFolder from internal hierarchy and it becomes a top-level scenario folder.
void	setDescription(java.lang.String pDescription) Sets the description for this OdiScenarioFolder.
void	setName(java.lang.String pName) Sets the name for this OdiScenarioFolder.

Methods inherited from class oracle.odi.domain.support.AbstractOdiEntity

getFirstDate, getFirstUser, getInternalVersion, getLastDate, getLastUser, isNew, preCommit, toString

Methods inherited from class oracle.odi.domain.support.AbstractRepositoryEntity

equals, getGlobalId, getNumericId, getParent, hashCode

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

Methods inherited from interface oracle.odi.domain.IRepositoryEntity

getGlobalId, getParent

Field Detail

NAME_MAX_LENGTH

public static final int NAME_MAX_LENGTH

Maximum name length allowed.

Since:

11.1.1.5.0

See Also:

Constant Field Values

Constructor Detail

OdiScenarioFolder

public OdiScenarioFolder(java.lang.String pName)

Constructs the top-level OdiScenarioFolder specified by the given name.

Parameters:

pName - name

Throws:

DomainRuntimeException - if pName is null, empty or longer than 400

Since:

11.1.1.5.0

OdiScenarioFolder

public OdiScenarioFolder(OdiScenarioFolder pParentScenFolder,
                         java.lang.String pName)

Constructs the OdiScenarioFolder specified by the given name within the given parent scenario folder.

Parameters:

pParentScenFolder - parent scenario folder

pName - name

Throws:

DomainRuntimeException - if pParentScenFolder is null or pName is null, empty

Since:

11.1.1.5.0

Method Detail

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

getScenarioFolderId

public java.lang.Number getScenarioFolderId()

Returns the unique ID of the scenario folder.

Returns:

the unique ID of the scenario folder

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

getName

public java.lang.String getName()

Gets name of this OdiScenarioFolder.

Specified by:

getName in interface IOdiEntity

Overrides:

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

Returns:

name of this OdiScenarioFolder

See Also:

setName(String)

getDescription

public java.lang.String getDescription()

Gets description of this OdiScenarioFolder.

Returns:

description of this OdiScenarioFolder

See Also:

setDescription(String)

getSubFolders

public java.util.Collection getSubFolders()

Gets an unmodifiable collection of sub-folders of this OdiScenarioFolder.

Returns:

unmodifiable collection of sub-folders of this OdiScenarioFolder

See Also:

addSubFolder(OdiScenarioFolder), removeSubFolder(OdiScenarioFolder)

getScenarios

public java.util.Collection getScenarios()

Gets an unmodifiable collection of OdiScenarios that belongs to this OdiScenarioFolder.

Returns:

unmodifiable collection of OdiScenarios that belongs to this OdiScenarioFolder

See Also:

addScenario(OdiScenario), removeScenario(OdiScenario)

getLoadPlans

public java.util.Collection getLoadPlans()

Gets an unmodifiable collection of OdiLoadPlan that belongs to this OdiScenarioFolder.

Returns:

unmodifiable collection of OdiLoadPlan that belongs to this OdiScenarioFolder

Since:

11.1.1.5.0

See Also:

addLoadPlan(OdiLoadPlan), removeLoadPlan(OdiLoadPlan)

getParentScenFolder

public OdiScenarioFolder getParentScenFolder()

Returns the parent OdiScenarioFolder of this OdiScenarioFolder or null if this is a root OdiScenarioFolder.

Returns:

an OdiFolder object representing the parent folder value

Since:

11.1.1.5.0

setName

public void setName(java.lang.String pName)

Sets the name for this OdiScenarioFolder.

Parameters:

pName - name

Throws:

DomainRuntimeException - if pName is null, empty or longer than 400

Since:

11.1.1.5.0

See Also:

getName()

setDescription

public void setDescription(java.lang.String pDescription)

Sets the description for this OdiScenarioFolder.

Parameters:

pDescription - description

Since:

11.1.1.5.0

See Also:

getDescription()

addSubFolder

public void addSubFolder(OdiScenarioFolder pSubScenFolder)

Add the given OdiScenarioFolder to this OdiScenarioFolder's hierarchy as a direct child.

Parameters:

pSubScenFolder - an OdiScenarioFolder object

Throws:

DomainRuntimeException - if pSubScenFolder is null or it attempts to create a cycle in OdiScenarioFolder's hierarchy

Since:

11.1.1.5.0

See Also:

removeSubFolder(OdiScenarioFolder), getSubFolders()

removeSubFolder

public void removeSubFolder(OdiScenarioFolder pSubScenFolder)

Removes the given OdiScenarioFolder from internal hierarchy and it becomes a top-level scenario folder.

Note: You will have to call IOdiEntityManager.remove(pSubScenFolder) in order to remove the OdiScenarioFolder from the repository.

Parameters:

pSubScenFolder - a child OdiScenarioFolder object

Throws:

DomainRuntimeException - if pSubScenFolder is null or is not a direct child for this OdiScenarioFolder

Since:

11.1.1.5.0

See Also:

addSubFolder(OdiScenarioFolder), getSubFolders()

addScenario

public void addScenario(OdiScenario pScenario)

Add the given OdiScenario to this OdiScenarioFolder.

Parameters:

pScenario - OdiScenario to add

Throws:

DomainRuntimeException - if pScenario is null

Since:

11.1.1.5.0

See Also:

removeScenario(OdiScenario), getScenarios()

removeScenario

public void removeScenario(OdiScenario pScenario)

Removes the given OdiScenario from this OdiScenarioFolder's hierarchy.

Note: You will have to call IOdiEntityManager.remove(pScenario) in order to remove the OdiScenario from the repository.

Parameters:

pScenario - scenario to remove

Throws:

DomainRuntimeException - if pScenario is null or does not belong to this OdiScenarioFolder

Since:

11.1.1.5.0

See Also:

addScenario(OdiScenario), getScenarios()

addLoadPlan

public void addLoadPlan(OdiLoadPlan pLoadPlan)

Add the given OdiLoadPlan to this OdiScenarioFolder.

Parameters:

pLoadPlan - OdiLoadPlan to add

Throws:

DomainRuntimeException - if pLoadPlan is null

Since:

11.1.1.5.0

See Also:

removeLoadPlan(OdiLoadPlan), getLoadPlans()

removeLoadPlan

public void removeLoadPlan(OdiLoadPlan pLoadPlan)

Removes the given OdiLoadPlan from this OdiScenarioFolder's hierarchy.

Note: You will have to call IOdiEntityManager.remove(pLoadPlan) in order to remove the OdiLoadPlan from the repository.

Parameters:

pLoadPlan - load plan to remove

Throws:

DomainRuntimeException - if pLoadPlan is null or does not belong to this OdiScenarioFolder

Since:

11.1.1.5.0

See Also:

addLoadPlan(OdiLoadPlan), getLoadPlans()