📝 Add docstrings to bug/fix_ors_incentive_logic

Docstrings generation was requested by @SauravBizbRolly.

* #99 (comment)

The following files were modified:

* `src/main/java/com/iemr/flw/service/impl/ChildCareServiceImpl.java`

Author: coderabbitai[bot]

src/main/java/com/iemr/flw/service/impl/ChildCareServiceImpl.java

@@ -562,6 +562,12 @@ public List<SAMResponseDTO> getSamVisitsByBeneficiary(GetBenRequestHandler reque
         return samResponseListDTO;
     }
 
+    /**
+     * Persist a list of ORS distribution records and create corresponding incentive records.
+     *
+     * @param orsDistributionDTOS list of ORS distribution DTOs; each DTO must include household id, userName, and a fields object containing `num_ors_packets`, `num_under5_children`, and `visit_date`
+     * @return a success message "Saved N ORS visit records successfully" when one or more records are saved, or `null` if no records were saved or an error occurred
+     */
     @Override
     public String saveOrsDistributionDetails(List<OrsDistributionDTO> orsDistributionDTOS) {
         try {
@@ -574,7 +580,7 @@ public String saveOrsDistributionDetails(List<OrsDistributionDTO> orsDistributio
                 orsDistribution.setNumOrsPackets(orsDistributionDTO.getFields().getNum_ors_packets().toString());
                 orsDistribution.setChildCount(orsDistributionDTO.getFields().getNum_under5_children().toString());
                 orsDistribution.setHouseholdId(orsDistributionDTO.getHouseHoldId());
-                orsDistribution.setUserId(userRepo.getUserIdByName(jwtUtil.getUserNameFromStorage()));
+                orsDistribution.setUserId(userRepo.getUserIdByName(orsDistributionDTO.getUserName()));
                 orsDistribution.setVisitDate(LocalDate.parse(orsDistributionDTO.getFields().getVisit_date(),formatter));
                 orsDistributionList.add(orsDistribution);
 
@@ -727,20 +733,29 @@ private void  checkAndAddSamVisitNRCReferalIncentive(List<SamVisit> samVisits){
         });
 
     }
+    /**
+     * Creates incentive activity records for ORS distributions when applicable.
+     *
+     * For each ORS distribution in the list, this method creates incentive records for
+     * the CHILD_HEALTH and ACTIVITY groups if corresponding incentive activities exist
+     * and the distribution has a non-null packet count.
+     *
+     * @param orsDistributionList list of ORS distribution entities to evaluate for incentives
+     */
     private void  checkAndAddOrdDistributionIncentive(List<OrsDistribution> orsDistributionList){
         orsDistributionList.forEach(orsDistribution -> {
             IncentiveActivity orsPacketActivityAM =
                     incentivesRepo.findIncentiveMasterByNameAndGroup("ORS_DISTRIBUTION", GroupName.CHILD_HEALTH.getDisplayName());
             IncentiveActivity orsPacketActivityCH =       incentivesRepo.findIncentiveMasterByNameAndGroup("ORS_DISTRIBUTION", GroupName.ACTIVITY.getDisplayName());
             if(orsPacketActivityAM!=null){
                 if(orsDistribution.getNumOrsPackets()!=null){
-                    createIncentiveRecordforOrsDistribution(orsDistribution,orsDistribution.getBeneficiaryId(),orsPacketActivityAM,jwtUtil.getUserNameFromStorage(),false);
+                    createIncentiveRecordforOrsDistribution(orsDistribution,orsDistribution.getBeneficiaryId(),orsPacketActivityAM,userRepo.getUserNamedByUserId(orsDistribution.getUserId()),false);
                 }
             }
 
             if(orsPacketActivityCH!=null){
                 if(orsDistribution.getNumOrsPackets()!=null){
-                    createIncentiveRecordforOrsDistribution(orsDistribution,orsDistribution.getBeneficiaryId(),orsPacketActivityCH,jwtUtil.getUserNameFromStorage(),true);
+                    createIncentiveRecordforOrsDistribution(orsDistribution,orsDistribution.getBeneficiaryId(),orsPacketActivityCH,userRepo.getUserNamedByUserId(orsDistribution.getUserId()),true);
                 }
             }
 
@@ -1061,4 +1076,4 @@ public void getTomorrowImmunizationReminders(Integer userID) {
 
     }
 
-}
+}