public class OdiLoadPlan extends AbstractOdiEntity implements IWorkRuntimeOdiEntity, IFlexFieldUser
An OdiLoadPlan is the root entity of the Load Plan aggregate.
Thus an instance of OdiLoadPlan controls the life cycle of every object of this aggregate and provides auditing information about it.
As such, it implements the IOdiEntity interface.
An OdiLoadPlan has an ID that can be obtained from getLoadPlanId() method call. This ID is assigned when an OdiLoadPlan is stored into the runtime repository.
This ID represents the identity of an OdiLoadPlan.
#equals() / Object.hashCode() methods are implemented according to this identity.
An OdiLoadPlan life cycle begins when a user creates an instance of this object. It is then stored inside ODI runtime repository.
The users can modify it in order to make it fit their needs.
The life cycle ends when a user deletes the instance from runtime repository (i.e. using IOdiEntityManager.remove()).
This class is offered to the user in order to create the objects so it mostly propose methods to build a load plan, add children components, etc?
Step moves:
OdiLoadPlanStep,
OdiLoadPlanVariable,
OdiLoadPlanException,
IOdiEntityManager,
IOdiEntity| Modifier and Type | Class and Description |
|---|---|
static class |
OdiLoadPlan.SessionLogsBehavior
Indicates how logs will be maintained by default for the session of each of the scenarios started by the Load Plan.
|
static class |
OdiLoadPlan.SessionStepLogsBehavior
Indicates how logs will be maintained by default for the session steps of each of the scenarios started by the Load Plan.
|
| Modifier and Type | Field and Description |
|---|---|
static int |
NAME_MAX_LENGTH
Maximum length for the name of the
OdiLoadPlan |
static java.lang.String |
ROOT_STEP
Name of the Root Step for the load plan
|
static int |
SESSION_KEYWORDS_MAX_LENGTH
Maximum length for session keywords strings
|
| Constructor and Description |
|---|
OdiLoadPlan(java.lang.String pName)
|
| Modifier and Type | Method and Description |
|---|---|
OdiLoadPlanException |
addException(java.lang.String pName)
Creates an
OdiLoadPlanException and adds it to the list of OdiLoadPlanException available for this OdiLoadPlan. |
OdiLoadPlanVariable |
addLoadPlanVariable(java.lang.String pVariableName,
OdiVariable.DataType pDataType,
java.lang.String pDescription,
IOdiVariableTextGenerator pGenerator) |
OdiLoadPlanVariable |
addVariable(OdiVariable pVariable,
IOdiVariableTextGenerator pGenerator)
Calls the code generation service and creates an instance of
OdiLoadPlanVariable from an OdiLoadPlanException.adds the created OdiLoadPlanVariable to the list of OdiLoadPlanVariable available for this OdiLoadPlan and returns it.If a OdiLoadPlanVariable corresponding to the parameter OdiVariable already exists, then the existing OdiLoadPlanVariable will be updated with the result of the code generation service.If the created OdiLoadPlanVariable needs other Variables for its refresh, these OdiVariable will also be added to the Load Plan. |
CecBehavior |
getCecLprBehavior() |
java.lang.Number |
getCecLprPollIntv() |
java.lang.String |
getDescription() |
java.util.Collection |
getExceptions() |
java.util.Collection |
getFlexFieldsValues()
Obtains flex fields values related to this
IFlexFieldUser. |
java.util.List |
getInstances() |
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 |
getLoadPlanId() |
java.util.List |
getLoadPlanSchedules() |
int |
getLogHistoryRetainedNbDays() |
java.lang.Number |
getMaxCecLpr() |
java.lang.String |
getName()
Returns the name of this entity instance.
|
OdiLoadPlanStepSerial |
getRootStep() |
OdiScenarioFolder |
getScenarioFolder() |
IRepositoryEntity |
getSecurityContainer() |
java.lang.String |
getSessionKeywordsAsString() |
OdiLoadPlan.SessionLogsBehavior |
getSessionLogsDefaultBehaviorForScenarios()
Indicates how logs will be maintained by default for the sessions of each of the scenarios started by the
OdiLoadPlan. |
OdiLoadPlan.SessionStepLogsBehavior |
getSessionLogsDefaultBehaviorForScenarioSteps()
Indicates how logs will be maintained by default for the session steps of each of the scenarios started by the Load Plan.
|
int |
getTaskLogLevel() |
OdiLoadPlanVariable |
getVariableIfExistsInLoadPlan(java.lang.String pLoadPlanVariableName)
Retrieve the
OdiLoadPlanVariable if it exists in the LoadPlan |
java.util.List |
getVariables() |
void |
initFlexFields(IOdiFlexFieldFinder odiFlexFieldFinder)
Initialize flex fields related to this
IFlexFieldUser. |
void |
moveStepIntoStepContainer(OdiLoadPlanStep pStepToMove,
OdiLoadPlanStepContainer pTargetContainer)
Moves an
OdiLoadPlanStep into a new step container and puts it at the end of the children list. |
void |
removeException(OdiLoadPlanException pLoadPlanStepException)
Removes the given
OdiLoadPlanException of the list of OdiLoadPlanException available for this OdiLoadPlan.The OdiLoadPlanException must not be null and must have the same parent OdiLoadPlan. |
void |
removeVariable(OdiLoadPlanVariable pLoadPlanVariable)
Removes the given
OdiLoadPlanVariable of the list of OdiLoadPlanVariable available for this OdiLoadPlan.If the variable is overridden on one or several steps, these usages will also be removed. If the variable is used as a test variable in a StepCase, the step case and its hierarchy of steps will be removed. The OdiLoadPlanVariable must not be null and must have the same parent OdiLoadPlan. |
void |
setCecLprBehavior(CecBehavior cecLprBehavior)
Set the
CecBehavior of this load plan that applies when getMaxCecLpr() returns a positive value. |
void |
setCecLprPollIntv(java.lang.Number cecLprPollIntv)
Set the polling interval (in seconds) that applies when getMaxCecLpr() returns a positive value and getCecLprBehavior() is WAIT.
|
void |
setDescription(java.lang.String pDescription) |
void |
setLogHistoryRetainedNbDays(int logHistoryRetainedNbDays) |
void |
setMaxCecLpr(java.lang.Number maxCecLpr)
Set the maximum number of allowed concurrent load plan runs for this Load Plan.
|
void |
setName(java.lang.String pName) |
void |
setScenarioFolder(OdiScenarioFolder pScenarioFolder) |
void |
setSessionKeywordsAsString(java.lang.String sessionKeywordsAsString) |
void |
setSessionLogsDefaultBehaviorForScenarios(OdiLoadPlan.SessionLogsBehavior sessionLogsDefaultBehaviorForScenarios)
Indicates how logs will be maintained by default for the sessions of each of the scenarios started by the
OdiLoadPlan.Must not be null. |
void |
setSessionLogsDefaultBehaviorForScenarioSteps(OdiLoadPlan.SessionStepLogsBehavior sessionLogsDefaultBehaviorForScenarioSteps)
Indicates how logs will be maintained by default for the session steps of each of the scenarios started by the Load Plan.
Must not be null |
void |
setTaskLogLevel(int taskLogLevel) |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitgetFirstDate, getFirstUser, getLastDate, getLastUser, isInstanceLevelSecurityNeededgetGlobalId, getParentpublic static final int NAME_MAX_LENGTH
OdiLoadPlansetName(String),
getName(),
name,
Constant Field Valuespublic static final int SESSION_KEYWORDS_MAX_LENGTH
public static final java.lang.String ROOT_STEP
public OdiLoadPlan(java.lang.String pName)
pName - the name of the OdiLoadPlan instances. Must not be null, empty or longer than NAME_MAX_LENGTHDomainRuntimeException - if the name is null, empty or longer than NAME_MAX_LENGTHpublic OdiLoadPlanException addException(java.lang.String pName)
OdiLoadPlanException and adds it to the list of OdiLoadPlanException available for this OdiLoadPlan.pName - the name of the OdiLoadPlanException created.OdiLoadPlanException instance createdOdiLoadPlanException,
removeException(OdiLoadPlanException),
getExceptions()public void removeException(OdiLoadPlanException pLoadPlanStepException)
OdiLoadPlanException of the list of OdiLoadPlanException available for this OdiLoadPlan.OdiLoadPlanException must not be null and must have the same parent OdiLoadPlan.pLoadPlanStepException - the OdiLoadPlanException to remove from the listDomainRuntimeException - if the exception is not defined in the load plan or is nullOdiLoadPlanException,
addException(String),
getExceptions()public OdiLoadPlanVariable addVariable(OdiVariable pVariable, IOdiVariableTextGenerator pGenerator) throws OdiVariableChangedDatatypeException, OdiVariableTextGeneratorException
OdiLoadPlanVariable from an OdiLoadPlanException.OdiLoadPlanVariable to the list of OdiLoadPlanVariable available for this OdiLoadPlan and returns it.OdiLoadPlanVariable corresponding to the parameter OdiVariable already exists, then the existing OdiLoadPlanVariable will be updated with the result of the code generation service.pVariable - the source OdiVariable that will be used to create the OdiLoadPlanVariable. Must not be null.pGenerator - the service in charge of the first step of code generation of the variable refresh sql text. Must not be null.OdiLoadPlanVariable created.OdiVariableChangedDatatypeException - if we try to add again a variable whose datatype changed in betweenOdiVariableTextGeneratorException - if variable refresh text generation failedOdiRuntimeException - Context specific errorsDomainRuntimeException - if the variable and/or the generator is nullOdiLoadPlanVariable,
removeVariable(OdiLoadPlanVariable),
getVariables(),
OdiVariableTextGeneratorFactorypublic OdiLoadPlanVariable addLoadPlanVariable(java.lang.String pVariableName, OdiVariable.DataType pDataType, java.lang.String pDescription, IOdiVariableTextGenerator pGenerator) throws OdiVariableChangedDatatypeException
public OdiLoadPlanVariable getVariableIfExistsInLoadPlan(java.lang.String pLoadPlanVariableName)
OdiLoadPlanVariable if it exists in the LoadPlanpLoadPlanVariableName - fully qualified name for this variableOdiLoadPlanVariablepublic void removeVariable(OdiLoadPlanVariable pLoadPlanVariable) throws OdiLoadPlanVariableUsedException
OdiLoadPlanVariable of the list of OdiLoadPlanVariable available for this OdiLoadPlan.OdiLoadPlanVariable must not be null and must have the same parent OdiLoadPlan.pLoadPlanVariable - OdiLoadPlanVariableUsedException{@link - IllegalArgumentException} if the LoadPlanVariable is null or not defined under the same loadplanOdiLoadPlanVariable,
#addVariable(OdiVariable),
getVariables()public void setScenarioFolder(OdiScenarioFolder pScenarioFolder)
public OdiScenarioFolder getScenarioFolder()
public 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 IRepositoryEntitypublic java.util.Collection getFlexFieldsValues()
IFlexFieldUserIFlexFieldUser.
In most implementations method IFlexFieldUser.initFlexFields(IOdiFlexFieldFinder) should be
called before calling this method.getFlexFieldsValues in interface IFlexFieldUserpublic void initFlexFields(IOdiFlexFieldFinder odiFlexFieldFinder)
IFlexFieldUserIFlexFieldUser.initFlexFields in interface IFlexFieldUserodiFlexFieldFinder - OdiFlexField finder to be used to query flex fieldspublic OdiLoadPlanStepSerial getRootStep()
OdiLoadPlanStepSerial defined as root for this OdiLoadPlan.initializeRootStep()public java.lang.Number getLoadPlanId()
OdiLoadPlanpublic java.lang.String getName()
IOdiEntitygetName in interface IFlexFieldUsergetName in interface IOdiEntityOdiLoadPlansetName(String)public void setName(java.lang.String pName)
name - the name of the OdiLoadPlan. Its length must be lower or equal to NAME_MAX_LENGTH. Must not be null or empty.DomainRuntimeException - if the name is null, empty or longer than NAME_MAX_LENGTHgetName(),
NAME_MAX_LENGTHpublic java.lang.String getSessionKeywordsAsString()
setSessionKeywordsAsString(String)public void setSessionKeywordsAsString(java.lang.String sessionKeywordsAsString)
sessionKeywordsAsString - Comma separated list of keywords to propagate to the sessions. Its length must be lower or equal to SESSION_KEYWORDS_MAX_LENGTHDomainRuntimeException - if the keywords are longer than the SESSION_KEYWORDS_MAX_LENGTHgetSessionKeywordsAsString(),
SESSION_KEYWORDS_MAX_LENGTHpublic OdiLoadPlan.SessionLogsBehavior getSessionLogsDefaultBehaviorForScenarios()
OdiLoadPlan.setSessionLogsDefaultBehaviorForScenarios(SessionLogsBehavior),
OdiLoadPlan.SessionLogsBehaviorpublic void setSessionLogsDefaultBehaviorForScenarios(OdiLoadPlan.SessionLogsBehavior sessionLogsDefaultBehaviorForScenarios)
OdiLoadPlan.sessionLogsDefaultBehaviorForScenarios - the default behavior for scenario logsDomainRuntimeException - if the behavior is null.getSessionLogsDefaultBehaviorForScenarios(),
OdiLoadPlan.SessionLogsBehaviorpublic OdiLoadPlan.SessionStepLogsBehavior getSessionLogsDefaultBehaviorForScenarioSteps()
#setSessionLogsDefaultBehaviorForScenarioSteps(SessionLogsBehavior),
OdiLoadPlan.SessionLogsBehaviorpublic void setSessionLogsDefaultBehaviorForScenarioSteps(OdiLoadPlan.SessionStepLogsBehavior sessionLogsDefaultBehaviorForScenarioSteps)
sessionLogsDefaultBehaviorForScenarioSteps - the default behavior for the session stepsDomainRuntimeException - if the behavior is nullgetSessionLogsDefaultBehaviorForScenarioSteps(),
OdiLoadPlan.SessionLogsBehaviorpublic int getLogHistoryRetainedNbDays()
OdiLoadPlan.setLogHistoryRetainedNbDays(int)public void setLogHistoryRetainedNbDays(int logHistoryRetainedNbDays)
logHistoryRetainedNbDays - Number of days for which log history will be kept for this OdiLoadPlan. It must be positive.DomainRuntimeException - if the number of days is negative.getLogHistoryRetainedNbDays()public int getTaskLogLevel()
OdiLoadPlanStepRunScenario are configured as RestartType = RUN_SCENARIO_FROM_STEP or RUN_SCENARIO_FROM_TASK, this property is ignored.setTaskLogLevel(int)public void setTaskLogLevel(int taskLogLevel)
taskLogLevel - the task level logging (1..5).OdiLoadPlanStepRunScenario are configured as RestartType = RUN_SCENARIO_FROM_STEP or RUN_SCENARIO_FROM_TASK, this property is ignored.DomainRuntimeException - if the level is not between 1 and 5.getTaskLogLevel()public java.lang.String getDescription()
OdiLoadPlansetDescription(String)public void setDescription(java.lang.String pDescription)
description - the description of the OdiLoadPlangetDescription()public java.util.Collection getExceptions()
OdiLoadPlanException defined for this OdiLoadPlanpublic java.util.List getInstances()
OdiLoadPlanInstance for this OdiLoadPlanpublic java.util.List getVariables()
OdiLoadPlanVariables defined for this OdiLoadPlanpublic java.util.List getLoadPlanSchedules()
OdiLoadPlanSchedule defined for this OdiLoadPlan.public void moveStepIntoStepContainer(OdiLoadPlanStep pStepToMove, OdiLoadPlanStepContainer pTargetContainer)
OdiLoadPlanStep into a new step container and puts it at the end of the children list.pStepToMove - pTargetContainer - DomainRuntimeException - if the step and the target container are not in the same loadplanDomainRuntimeException - if moving a root step (LoadPlan root, caseWhen/CaseElse root step)DomainRuntimeException - if moving a step from inside an exception to the loadplan hierarchyDomainRuntimeException - if moving a step from the loadplan hierarchy to inside an exceptionpublic IRepositoryEntity getSecurityContainer()
getSecurityContainer in interface IRepositoryEntitypublic java.lang.Number getMaxCecLpr()
public void setMaxCecLpr(java.lang.Number maxCecLpr)
maxCecLpr - public CecBehavior getCecLprBehavior()
CecBehavior of this load plan that applies when getMaxCecLpr() returns a positive value.public void setCecLprBehavior(CecBehavior cecLprBehavior)
CecBehavior of this load plan that applies when getMaxCecLpr() returns a positive value.public java.lang.Number getCecLprPollIntv()
public void setCecLprPollIntv(java.lang.Number cecLprPollIntv)