public final class OdiScenarioFolder extends oracle.odi.domain.support.AbstractOdiEntity implements IWorkRuntimeOdiEntity, oracle.odi.impexp.smartie.ISmartExportable, oracle.odi.core.audit.support.IAuditableFirstClassObject
An OdiScenarioFolder
is a group of OdiScenario
s. 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 (OdiScenario
s as well as sub OdiScenarioFolder
s).
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 OdiScenario
s and other OdiScenarioFolder
s.
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.
Modifier and Type | Field and Description |
---|---|
static int |
NAME_MAX_LENGTH
Maximum name length allowed.
|
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. |
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.
|
IRepositoryEntity |
getSecurityContainer()
Define a generic way to retrieve container for entities.
|
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 . |
equals, getFirstDate, getFirstUser, getInternalVersion, getLastDate, getLastUser, hashCode, isNew, preCommit, toString
getGlobalId, getNumericId, hasCustomizedPersistenceMethodFor, invokeCustomizedPersistenceMethodFor
getFirstDate, getFirstUser, getLastDate, getLastUser
getGlobalId
public static final int NAME_MAX_LENGTH
public OdiScenarioFolder(java.lang.String pName)
OdiScenarioFolder
specified by the given name.pName
- nameDomainRuntimeException
- if pName is null, empty or longer than
400public OdiScenarioFolder(OdiScenarioFolder pParentScenFolder, java.lang.String pName)
OdiScenarioFolder
specified by the given name within
the given parent scenario folder.pParentScenFolder
- parent scenario folderpName
- nameDomainRuntimeException
- if pParentScenFolder is null or pName is null,
emptypublic java.io.Serializable getInternalId()
IRepositoryEntity
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.
getInternalId
in interface IRepositoryEntity
public java.lang.Number getScenarioFolderId()
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 java.lang.String getName()
getName
in interface IOdiEntity
getName
in class oracle.odi.domain.support.AbstractOdiEntity
setName(String)
public java.lang.String getDescription()
setDescription(String)
public java.util.Collection getSubFolders()
addSubFolder(OdiScenarioFolder)
,
removeSubFolder(OdiScenarioFolder)
public java.util.Collection getScenarios()
addScenario(OdiScenario)
,
removeScenario(OdiScenario)
public java.util.Collection getLoadPlans()
addLoadPlan(OdiLoadPlan)
,
removeLoadPlan(OdiLoadPlan)
public OdiScenarioFolder getParentScenFolder()
null
if this is a root OdiScenarioFolder.public IRepositoryEntity getSecurityContainer()
IRepositoryEntity
getSecurityContainer
in interface IRepositoryEntity
public void setName(java.lang.String pName)
OdiScenarioFolder
.pName
- nameDomainRuntimeException
- if pName is null, empty or longer than
400getName()
public void setDescription(java.lang.String pDescription)
OdiScenarioFolder
.pDescription
- descriptiongetDescription()
public void addSubFolder(OdiScenarioFolder pSubScenFolder)
OdiScenarioFolder
to this OdiScenarioFolder
's
hierarchy as a direct child.pSubScenFolder
- an OdiScenarioFolder
objectDomainRuntimeException
- if pSubScenFolder is null or it attempts to
create a cycle in OdiScenarioFolder
's hierarchyremoveSubFolder(OdiScenarioFolder)
,
getSubFolders()
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.
pSubScenFolder
- a child OdiScenarioFolder
objectDomainRuntimeException
- if pSubScenFolder is null or is not a direct
child for this OdiScenarioFolder
addSubFolder(OdiScenarioFolder)
,
getSubFolders()
public void addScenario(OdiScenario pScenario)
OdiScenario
to this OdiScenarioFolder
.pScenario
- OdiScenario
to addDomainRuntimeException
- if pScenario is nullremoveScenario(OdiScenario)
,
getScenarios()
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.
pScenario
- scenario to removeDomainRuntimeException
- if pScenario is null or does not belong to this
OdiScenarioFolder
addScenario(OdiScenario)
,
getScenarios()
public void addLoadPlan(OdiLoadPlan pLoadPlan)
OdiLoadPlan
to this OdiScenarioFolder
.pLoadPlan
- OdiLoadPlan
to addDomainRuntimeException
- if pLoadPlan is nullremoveLoadPlan(OdiLoadPlan)
,
getLoadPlans()
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.
pLoadPlan
- load plan to removeDomainRuntimeException
- if pLoadPlan is null or does not belong to this
OdiScenarioFolder
addLoadPlan(OdiLoadPlan)
,
getLoadPlans()