Class CostComputationData
java.lang.Object
org.ametys.plugins.odfpilotage.cost.entity.CostComputationData
This class store all of the information computed by the
CostComputationComponent
-
Field Summary
Modifier and TypeFieldDescriptionprotected Map<CoursePart,
CoursePartCostData> All informations about each coursePart gathered by their idprotected Map<String,
Effectives> Effectives informations gathered by a program itemTD equivalent values gathered by a program itemAll td equivalent by step gathered by their program item idAll effectives by step gathered by their program item idprotected List<ProgramItem>
List of program items in the program structureprotected Map<ProgramItem,
Map<String, Container>> Steps gathered by their programprotected Map<String,
VolumesOfHours> Hourly volume gathered by a program item -
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionvoid
add
(Double effective, Container step, ProgramItem programItem) Add a new effective by step to a program itemvoid
Transfer and compute effectives by step of the parent to the program itemvoid
addCoursePartCostData
(CoursePart coursePart, CoursePartCostData coursePartCostData) Add an element in the coursePartInformation mapvoid
addEnteredEffective
(String programItemId, Optional<Double> enteredEffective) Affect a new entered effective to a programItemvoid
Add a new TD equivalent to a programItemvoid
addEqTDByStep
(String coursePartId, Map<Container, Double> eqTDByStep) Affect eqTD values by step to a course partvoid
addGlobalComputedEffective
(String programItemId, Double computedGlobalEffective) Affect a new global computed effective to a programItemvoid
addHeReport
(String programItemPath, Double heReport) Add a new HE report value to a programItemvoid
addLocalComputedEffective
(String programItemId, String programItemPath, Double effectifCalculeLocal) Affect a new local computed effective to a programItemvoid
addProgramItem
(ProgramItem programItem) Add a new ProgramItem to the structurevoid
addSteps
(Map<String, Container> steps, ProgramItem programItem) Add all steps of a program itemvoid
addVolumeOfHours
(String programItemId, VolumesOfHours volumeOfHours) Add a new volume of hours to a programItemvoid
cloneWithWeight
(double weight, ProgramItem programItem) Apply a weight to all effectives by step of a program itemcontains
(ProgramItem programItem) Check if the program item belong to current structureGet all effectives by stepgetComputedLocalEffective
(String programItemId, String programItempath) Get the local computed effective of a program itemGet the computedCourseParts mapgetCoursePartCostData
(CoursePart coursePart) Get coursePart informations retrieved by a coursePartgetEffective
(String programItemId) Get the effective of a programItemgetEffectiveByStep
(String programItemId) Get effectives by step of a program itemgetEnteredEffective
(String programItemId) Get the entered effective of a programItemGet the TD equivalent of a programItemgetEqTDByStep
(String coursePartId) Get eqTD values of a course partGet all global eqTD valuesGet all local eqTD valuesGet all pro-rated eqTD valuesgetGlobalComputedEffective
(String programItemId) Get the global computed effective of a programItemGet all HE report valuesgetHeReport
(String programItemPath) Get the HE report value of a programItemGet the program item structuregetSteps()
Get all steps of all program itemGet all volumes of hours gathered by their program item idgetVolumesOfHours
(String programItemId) Get the volume of hours of a programItemboolean
hasCoursePartsInfos
(CoursePart coursePart) Check if the map contains the key in parametervoid
setEffective
(String programItemId, Effectives effective) Add the effective of a programItem
-
Field Details
-
_coursePartsCostData
All informations about each coursePart gathered by their id -
_steps
Steps gathered by their program -
_volumesOfHours
Hourly volume gathered by a program item -
_effectives
Effectives informations gathered by a program item -
_eqTD
TD equivalent values gathered by a program item -
_programItemStructure
List of program items in the program structure -
_eqTDByStep
All td equivalent by step gathered by their program item id -
_programItemEffectiveByStep
All effectives by step gathered by their program item id
-
-
Constructor Details
-
CostComputationData
public CostComputationData()The constructor
-
-
Method Details
-
addProgramItem
Add a new ProgramItem to the structure- Parameters:
programItem
- the new ProgramItem
-
contains
Check if the program item belong to current structure- Parameters:
programItem
- the programItem- Returns:
- true if the list contains the programItem in parameter
-
getProgramItemStructure
Get the program item structure- Returns:
- the program item structure
-
getCoursePartCostData
Get the computedCourseParts map- Returns:
- the computedCourseParts map
-
addCoursePartCostData
Add an element in the coursePartInformation map- Parameters:
coursePart
- the coursePartcoursePartCostData
- cost data values of the coursePart
-
hasCoursePartsInfos
Check if the map contains the key in parameter- Parameters:
coursePart
- the key- Returns:
- true is the map contains the key
-
getCoursePartCostData
Get coursePart informations retrieved by a coursePart- Parameters:
coursePart
- the coursePart- Returns:
- coursePart informations
-
cloneWithWeight
Apply a weight to all effectives by step of a program item- Parameters:
weight
- the weightprogramItem
- the program item
-
add
Add a new effective by step to a program item- Parameters:
effective
- the effective to sumstep
- the stepprogramItem
- the program item
-
add
Transfer and compute effectives by step of the parent to the program item- Parameters:
parentId
- the id of the parentprogramItemId
- the id of the program item
-
addEnteredEffective
Affect a new entered effective to a programItem- Parameters:
programItemId
- the id of the programItementeredEffective
- the new entered effective
-
addGlobalComputedEffective
Affect a new global computed effective to a programItem- Parameters:
programItemId
- the id of the programItemcomputedGlobalEffective
- the new computed global effective
-
addLocalComputedEffective
public void addLocalComputedEffective(String programItemId, String programItemPath, Double effectifCalculeLocal) Affect a new local computed effective to a programItem- Parameters:
programItemId
- the id of the programItemprogramItemPath
- the current patheffectifCalculeLocal
- the new computed local effective
-
getEnteredEffective
Get the entered effective of a programItem- Parameters:
programItemId
- the id of the programItem- Returns:
- the optional value of the effective
-
getGlobalComputedEffective
Get the global computed effective of a programItem- Parameters:
programItemId
- the id of the programItem- Returns:
- the optional value of the effective
-
getComputedLocalEffective
Get the local computed effective of a program item- Parameters:
programItemId
- the id of the program itemprogramItempath
- the program item path- Returns:
- the optional value of the effective
-
getEffective
Get the effective of a programItem- Parameters:
programItemId
- the id of the programItem- Returns:
- the effective
-
setEffective
Add the effective of a programItem- Parameters:
programItemId
- the id of the programItemeffective
- the effective
-
getVolumesOfHours
Get the volume of hours of a programItem- Parameters:
programItemId
- the id of the programItem- Returns:
- the hourly volume
-
getVolumesOfHours
Get all volumes of hours gathered by their program item id- Returns:
- all volumes of hours
-
addVolumeOfHours
Add a new volume of hours to a programItem- Parameters:
programItemId
- the id of the programItemvolumeOfHours
- the volume of hours
-
addEqTD
Add a new TD equivalent to a programItem- Parameters:
programItemId
- the id of the programItemeqTD
- the TD equivalent
-
getEqTD
Get the TD equivalent of a programItem- Parameters:
programItemId
- the id of a programItem- Returns:
- the TD equivalent
-
addSteps
Add all steps of a program item- Parameters:
steps
- all stepsprogramItem
- the program item
-
getSteps
Get all steps of all program item- Returns:
- all steps of all program item
-
getAllEffectivesByStep
Get all effectives by step- Returns:
- all effectives by step
-
getEffectiveByStep
Get effectives by step of a program item- Parameters:
programItemId
- the program item id- Returns:
- effectives by step of a program item
-
addEqTDByStep
Affect eqTD values by step to a course part- Parameters:
coursePartId
- the coursePart ideqTDByStep
- eqTD by step values
-
getEqTDByStep
Get eqTD values of a course part- Parameters:
coursePartId
- the course part id- Returns:
- eqTD values
-
addHeReport
Add a new HE report value to a programItem- Parameters:
programItemPath
- the path of the programItemheReport
- the HE report value
-
getHeReport
Get the HE report value of a programItem- Parameters:
programItemPath
- the path of a programItem- Returns:
- the HE report value
-
getHeReport
Get all HE report values- Returns:
- all HE report values
-
getEqTDProratise
Get all pro-rated eqTD values- Returns:
- all pro-rated eqTD values
-
getEqTDPorte
Get all local eqTD values- Returns:
- all local eqTD values
-
getEqTDGlobal
Get all global eqTD values- Returns:
- all global eqTD values
-