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, IOdiEntity, IRepositoryEntity, IWorkRuntimeOdiEntity

public final class OdiScenarioFolder
extends oracle.odi.domain.support.AbstractOdiEntity
implements IWorkRuntimeOdiEntity

*

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 inherited from class oracle.odi.domain.support.AbstractOdiEntity

STARTING_INTERNAL_VERSION

Method Summary

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.lang.String	getName() Gets name of this OdiScenarioFolder.
java.lang.Number	getScenarioFolderId() Returns the unique ID of the scenario folder.
java.util.Collection<OdiScenario>	getScenarios() Gets an unmodifiable collection of OdiScenarios that belongs to this OdiScenarioFolder.
IRepositoryEntity	getSecurityContainer() Define a generic way to retrieve container for entities.
java.util.Collection<OdiScenarioFolder>	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.

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

Method Detail

getDescription

public java.lang.String getDescription()

Gets description of this OdiScenarioFolder.

Returns:

description of this OdiScenarioFolder

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

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

getScenarioFolderId

public java.lang.Number getScenarioFolderId()

Returns the unique ID of the scenario folder.

Returns:

the unique ID of the scenario folder

getScenarios

public java.util.Collection<OdiScenario> getScenarios()

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

Returns:

unmodifiable collection of OdiScenarios that belongs to this OdiScenarioFolder

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<OdiScenarioFolder> getSubFolders()

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

Returns:

unmodifiable collection of sub-folders of this OdiScenarioFolder

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