001// --------------------------------------------------------------------------------
002// Copyright 2002-2025 Echo Three, LLC
003//
004// Licensed under the Apache License, Version 2.0 (the "License");
005// you may not use this file except in compliance with the License.
006// You may obtain a copy of the License at
007//
008//     http://www.apache.org/licenses/LICENSE-2.0
009//
010// Unless required by applicable law or agreed to in writing, software
011// distributed under the License is distributed on an "AS IS" BASIS,
012// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013// See the License for the specific language governing permissions and
014// limitations under the License.
015// --------------------------------------------------------------------------------
016
017package com.echothree.model.control.training.server.transfer;
018
019import com.echothree.model.control.training.common.TrainingOptions;
020import com.echothree.model.control.training.common.transfer.TrainingClassTransfer;
021import com.echothree.model.control.training.server.control.TrainingControl;
022import com.echothree.model.control.uom.common.UomConstants;
023import com.echothree.model.control.uom.server.control.UomControl;
024import com.echothree.model.control.workeffort.server.control.WorkEffortControl;
025import com.echothree.model.data.training.server.entity.TrainingClass;
026import com.echothree.model.data.user.server.entity.UserVisit;
027import com.echothree.util.common.transfer.ListWrapper;
028import com.echothree.util.server.persistence.Session;
029import com.echothree.util.server.string.PercentUtils;
030import com.echothree.util.server.string.UnitOfMeasureUtils;
031import javax.enterprise.context.RequestScoped;
032
033@RequestScoped
034public class TrainingClassTransferCache
035        extends BaseTrainingTransferCache<TrainingClass, TrainingClassTransfer> {
036
037    TrainingControl trainingControl = Session.getModelController(TrainingControl.class);
038    UomControl uomControl = Session.getModelController(UomControl.class);
039    WorkEffortControl workEffortControl = Session.getModelController(WorkEffortControl.class);
040
041    boolean includeTrainingClassSections;
042    boolean includePartyTrainingClasses;
043    
044    /** Creates a new instance of TrainingClassTransferCache */
045    protected TrainingClassTransferCache() {
046        super();
047        
048        var options = session.getOptions();
049        if(options != null) {
050            includeTrainingClassSections = options.contains(TrainingOptions.TrainingClassIncludeTrainingClassSections);
051            includePartyTrainingClasses = options.contains(TrainingOptions.TrainingClassIncludePartyTrainingClasses);
052        }
053        
054        setIncludeEntityInstance(true);
055    }
056    
057    public TrainingClassTransfer getTrainingClassTransfer(UserVisit userVisit, TrainingClass trainingClass) {
058        var trainingClassTransfer = get(trainingClass);
059        
060        if(trainingClassTransfer == null) {
061            var trainingClassDetail = trainingClass.getLastDetail();
062            var trainingClassName = trainingClassDetail.getTrainingClassName();
063            var timeUnitOfMeasureKind = uomControl.getUnitOfMeasureKindByUnitOfMeasureKindUseTypeUsingNames(UomConstants.UnitOfMeasureKindUseType_TIME);
064            var unitOfMeasureUtils = UnitOfMeasureUtils.getInstance();
065            var unformattedEstimatedReadingTime = trainingClassDetail.getEstimatedReadingTime();
066            var estimatedReadingTime = unitOfMeasureUtils.formatUnitOfMeasure(userVisit, timeUnitOfMeasureKind, unformattedEstimatedReadingTime);
067            var unformattedReadingTimeAllowed = trainingClassDetail.getReadingTimeAllowed();
068            var readingTimeAllowed = unitOfMeasureUtils.formatUnitOfMeasure(userVisit, timeUnitOfMeasureKind, unformattedReadingTimeAllowed);
069            var unformattedEstimatedTestingTime = trainingClassDetail.getEstimatedTestingTime();
070            var estimatedTestingTime = unitOfMeasureUtils.formatUnitOfMeasure(userVisit, timeUnitOfMeasureKind, unformattedEstimatedTestingTime);
071            var unformattedTestingTimeAllowed = trainingClassDetail.getTestingTimeAllowed();
072            var testingTimeAllowed = unitOfMeasureUtils.formatUnitOfMeasure(userVisit, timeUnitOfMeasureKind, unformattedTestingTimeAllowed);
073            var unformattedRequiredCompletionTime = trainingClassDetail.getRequiredCompletionTime();
074            var requiredCompletionTime = unitOfMeasureUtils.formatUnitOfMeasure(userVisit, timeUnitOfMeasureKind, unformattedRequiredCompletionTime);
075            var workEffortScope = trainingClassDetail.getWorkEffortScope();
076            var workEffortScopeTransfer = workEffortScope == null ? null : workEffortControl.getWorkEffortScopeTransfer(userVisit, workEffortScope);
077            var unformattedDefaultPercentageToPass = trainingClassDetail.getDefaultPercentageToPass();
078            var defaultPercentageToPass = PercentUtils.getInstance().formatFractionalPercent(unformattedDefaultPercentageToPass);
079            var overallQuestionCount = trainingClassDetail.getOverallQuestionCount();
080            var unformattedTestingValidityTime = trainingClassDetail.getTestingValidityTime();
081            var testingValidityTime = unitOfMeasureUtils.formatUnitOfMeasure(userVisit, timeUnitOfMeasureKind, unformattedTestingValidityTime);
082            var unformattedExpiredRetentionTime = trainingClassDetail.getExpiredRetentionTime();
083            var expiredRetentionTime = unitOfMeasureUtils.formatUnitOfMeasure(userVisit, timeUnitOfMeasureKind, unformattedExpiredRetentionTime);
084            var alwaysReassignOnExpiration = trainingClassDetail.getAlwaysReassignOnExpiration();
085            var isDefault = trainingClassDetail.getIsDefault();
086            var sortOrder = trainingClassDetail.getSortOrder();
087            var trainingClassTranslation = trainingControl.getBestTrainingClassTranslation(trainingClass, getLanguage(userVisit));
088            var description = trainingClassTranslation == null ? trainingClassName : trainingClassTranslation.getDescription();
089            
090            trainingClassTransfer = new TrainingClassTransfer(trainingClassName, unformattedEstimatedReadingTime, estimatedReadingTime,
091                    unformattedReadingTimeAllowed, readingTimeAllowed, unformattedEstimatedTestingTime, estimatedTestingTime, unformattedTestingTimeAllowed,
092                    testingTimeAllowed, unformattedRequiredCompletionTime, requiredCompletionTime, workEffortScopeTransfer, unformattedDefaultPercentageToPass,
093                    defaultPercentageToPass, overallQuestionCount, unformattedTestingValidityTime, testingValidityTime, unformattedExpiredRetentionTime,
094                    expiredRetentionTime, alwaysReassignOnExpiration, isDefault, sortOrder, description);
095            put(userVisit, trainingClass, trainingClassTransfer);
096            
097            if(includeTrainingClassSections) {
098                trainingClassTransfer.setTrainingClassSections(new ListWrapper<>(trainingControl.getTrainingClassSectionTransfers(userVisit, trainingClass)));
099            }
100            
101            if(includePartyTrainingClasses) {
102                trainingClassTransfer.setPartyTrainingClasses(new ListWrapper<>(trainingControl.getPartyTrainingClassTransfersByTrainingClass(userVisit, trainingClass)));
103            }
104        }
105        
106        return trainingClassTransfer;
107    }
108    
109}