001// --------------------------------------------------------------------------------
002// Copyright 2002-2026 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.control.user.training.server.command;
018
019import com.echothree.control.user.training.common.edit.TrainingClassSectionEdit;
020import com.echothree.control.user.training.common.edit.TrainingEditFactory;
021import com.echothree.control.user.training.common.form.EditTrainingClassSectionForm;
022import com.echothree.control.user.training.common.result.EditTrainingClassSectionResult;
023import com.echothree.control.user.training.common.result.TrainingResultFactory;
024import com.echothree.control.user.training.common.spec.TrainingClassSectionSpec;
025import com.echothree.model.control.core.common.MimeTypeUsageTypes;
026import com.echothree.model.control.core.server.logic.MimeTypeLogic;
027import com.echothree.model.control.party.common.PartyTypes;
028import com.echothree.model.control.security.common.SecurityRoleGroups;
029import com.echothree.model.control.security.common.SecurityRoles;
030import com.echothree.model.control.training.server.control.TrainingControl;
031import com.echothree.model.data.core.server.entity.MimeType;
032import com.echothree.model.data.training.server.entity.TrainingClass;
033import com.echothree.model.data.training.server.entity.TrainingClassSection;
034import com.echothree.model.data.user.common.pk.UserVisitPK;
035import com.echothree.util.common.message.ExecutionErrors;
036import com.echothree.util.common.validation.FieldDefinition;
037import com.echothree.util.common.validation.FieldType;
038import com.echothree.util.common.command.EditMode;
039import com.echothree.util.server.control.BaseAbstractEditCommand;
040import com.echothree.util.server.control.CommandSecurityDefinition;
041import com.echothree.util.server.control.PartyTypeDefinition;
042import com.echothree.util.server.control.SecurityRoleDefinition;
043import com.echothree.util.server.string.PercentUtils;
044import java.util.List;
045import javax.enterprise.context.Dependent;
046import javax.inject.Inject;
047
048@Dependent
049public class EditTrainingClassSectionCommand
050        extends BaseAbstractEditCommand<TrainingClassSectionSpec, TrainingClassSectionEdit, EditTrainingClassSectionResult, TrainingClassSection, TrainingClassSection> {
051    
052    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
053    private final static List<FieldDefinition> SPEC_FIELD_DEFINITIONS;
054    private final static List<FieldDefinition> EDIT_FIELD_DEFINITIONS;
055    
056    static {
057        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(List.of(
058                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
059                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
060                        new SecurityRoleDefinition(SecurityRoleGroups.TrainingClassSection.name(), SecurityRoles.Edit.name())
061                ))
062        ));
063
064        SPEC_FIELD_DEFINITIONS = List.of(
065                new FieldDefinition("TrainingClassName", FieldType.ENTITY_NAME, true, null, null),
066                new FieldDefinition("TrainingClassSectionName", FieldType.ENTITY_NAME, true, null, null)
067        );
068
069        EDIT_FIELD_DEFINITIONS = List.of(
070                new FieldDefinition("TrainingClassSectionName", FieldType.ENTITY_NAME, true, null, null),
071                new FieldDefinition("PercentageToPass", FieldType.FRACTIONAL_PERCENT, false, null, null),
072                new FieldDefinition("QuestionCount", FieldType.UNSIGNED_INTEGER, false, null, null),
073                new FieldDefinition("SortOrder", FieldType.SIGNED_INTEGER, true, null, null),
074                new FieldDefinition("Description", FieldType.STRING, false, 1L, 132L),
075                new FieldDefinition("OverviewMimeTypeName", FieldType.MIME_TYPE, false, null, null),
076                new FieldDefinition("Overview", FieldType.STRING, false, null, null),
077                new FieldDefinition("IntroductionMimeTypeName", FieldType.MIME_TYPE, false, null, null),
078                new FieldDefinition("Introduction", FieldType.STRING, false, null, null)
079        );
080    }
081
082    @Inject
083    TrainingControl trainingControl;
084
085    @Inject
086    MimeTypeLogic mimeTypeLogic;
087
088    
089    /** Creates a new instance of EditTrainingClassSectionCommand */
090    public EditTrainingClassSectionCommand() {
091        super(COMMAND_SECURITY_DEFINITION, SPEC_FIELD_DEFINITIONS, EDIT_FIELD_DEFINITIONS);
092    }
093    
094    @Override
095    public EditTrainingClassSectionResult getResult() {
096        return TrainingResultFactory.getEditTrainingClassSectionResult();
097    }
098
099    @Override
100    public TrainingClassSectionEdit getEdit() {
101        return TrainingEditFactory.getTrainingClassSectionEdit();
102    }
103
104    TrainingClass trainingClass;
105    
106    @Override
107    public TrainingClassSection getEntity(EditTrainingClassSectionResult result) {
108        TrainingClassSection trainingClassSection = null;
109        var trainingClassName = spec.getTrainingClassName();
110
111        trainingClass = trainingControl.getTrainingClassByName(trainingClassName);
112
113        if(trainingClass != null) {
114            var trainingClassSectionName = spec.getTrainingClassSectionName();
115
116            if(editMode.equals(EditMode.LOCK) || editMode.equals(EditMode.ABANDON)) {
117                trainingClassSection = trainingControl.getTrainingClassSectionByName(trainingClass, trainingClassSectionName);
118            } else { // EditMode.UPDATE
119                trainingClassSection = trainingControl.getTrainingClassSectionByNameForUpdate(trainingClass, trainingClassSectionName);
120            }
121
122            if(trainingClassSection != null) {
123                result.setTrainingClassSection(trainingControl.getTrainingClassSectionTransfer(getUserVisit(), trainingClassSection));
124            } else {
125                addExecutionError(ExecutionErrors.UnknownTrainingClassSectionName.name(), trainingClassName, trainingClassSectionName);
126            }
127        } else {
128            addExecutionError(ExecutionErrors.UnknownTrainingClassName.name(), trainingClassName);
129        }
130
131        return trainingClassSection;
132    }
133
134    @Override
135    public TrainingClassSection getLockEntity(TrainingClassSection trainingClassSection) {
136        return trainingClassSection;
137    }
138
139    @Override
140    public void fillInResult(EditTrainingClassSectionResult result, TrainingClassSection trainingClassSection) {
141        result.setTrainingClassSection(trainingControl.getTrainingClassSectionTransfer(getUserVisit(), trainingClassSection));
142    }
143
144    MimeType overviewMimeType;
145    MimeType introductionMimeType;
146    
147    @Override
148    public void doLock(TrainingClassSectionEdit edit, TrainingClassSection trainingClassSection) {
149        var trainingClassSectionTranslation = trainingControl.getTrainingClassSectionTranslation(trainingClassSection, getPreferredLanguage());
150        var trainingClassSectionDetail = trainingClassSection.getLastDetail();
151        var questionCount = trainingClassSectionDetail.getQuestionCount();
152
153        edit.setTrainingClassSectionName(trainingClassSectionDetail.getTrainingClassSectionName());
154        edit.setPercentageToPass(PercentUtils.getInstance().formatFractionalPercent(trainingClassSectionDetail.getPercentageToPass()));
155        edit.setQuestionCount(questionCount == null? null: questionCount.toString());
156        edit.setSortOrder(trainingClassSectionDetail.getSortOrder().toString());
157
158        if(trainingClassSectionTranslation != null) {
159            overviewMimeType = trainingClassSectionTranslation.getOverviewMimeType();
160            introductionMimeType = trainingClassSectionTranslation.getIntroductionMimeType();
161
162            edit.setDescription(trainingClassSectionTranslation.getDescription());
163            edit.setOverviewMimeTypeName(overviewMimeType == null? null: overviewMimeType.getLastDetail().getMimeTypeName());
164            edit.setOverview(trainingClassSectionTranslation.getOverview());
165            edit.setIntroductionMimeTypeName(introductionMimeType == null? null: introductionMimeType.getLastDetail().getMimeTypeName());
166            edit.setIntroduction(trainingClassSectionTranslation.getIntroduction());
167        }
168    }
169
170    @Override
171    public void canUpdate(TrainingClassSection trainingClassSection) {
172        var trainingClassSectionName = edit.getTrainingClassSectionName();
173        var duplicateTrainingClassSection = trainingControl.getTrainingClassSectionByName(trainingClass, trainingClassSectionName);
174
175        if(duplicateTrainingClassSection != null && !trainingClassSection.equals(duplicateTrainingClassSection)) {
176            addExecutionError(ExecutionErrors.DuplicateTrainingClassSectionName.name(), trainingClassSectionName);
177        } else {
178            var overviewMimeTypeName = edit.getOverviewMimeTypeName();
179            var overview = edit.getOverview();
180
181            overviewMimeType = mimeTypeLogic.checkMimeType(this, overviewMimeTypeName, overview, MimeTypeUsageTypes.TEXT.name(),
182                    ExecutionErrors.MissingRequiredOverviewMimeTypeName.name(), ExecutionErrors.MissingRequiredOverview.name(),
183                    ExecutionErrors.UnknownOverviewMimeTypeName.name(), ExecutionErrors.UnknownOverviewMimeTypeUsage.name());
184
185            if(!hasExecutionErrors()) {
186                var introductionMimeTypeName = edit.getIntroductionMimeTypeName();
187                var introduction = edit.getIntroduction();
188
189                introductionMimeType = mimeTypeLogic.checkMimeType(this, introductionMimeTypeName, introduction, MimeTypeUsageTypes.TEXT.name(),
190                        ExecutionErrors.MissingRequiredIntroductionMimeTypeName.name(), ExecutionErrors.MissingRequiredIntroduction.name(),
191                        ExecutionErrors.UnknownIntroductionMimeTypeName.name(), ExecutionErrors.UnknownIntroductionMimeTypeUsage.name());
192            }
193        }
194    }
195    
196    @Override
197    public void doUpdate(TrainingClassSection trainingClassSection) {
198        var partyPK = getPartyPK();
199        var trainingClassSectionDetailValue = trainingControl.getTrainingClassSectionDetailValueForUpdate(trainingClassSection);
200        var trainingClassSectionTranslation = trainingControl.getTrainingClassSectionTranslationForUpdate(trainingClassSection, getPreferredLanguage());
201        var percentageToPass = edit.getPercentageToPass();
202        var questionCount = edit.getQuestionCount();
203        var description = edit.getDescription();
204        var overview = edit.getOverview();
205        var introduction = edit.getIntroduction();
206
207        trainingClassSectionDetailValue.setTrainingClassSectionName(edit.getTrainingClassSectionName());
208        trainingClassSectionDetailValue.setPercentageToPass(percentageToPass == null ? null : Integer.valueOf(percentageToPass));
209        trainingClassSectionDetailValue.setQuestionCount(questionCount == null ? null : Integer.valueOf(questionCount));
210        trainingClassSectionDetailValue.setSortOrder(Integer.valueOf(edit.getSortOrder()));
211
212        trainingControl.updateTrainingClassSectionFromValue(trainingClassSectionDetailValue, partyPK);
213
214        if(trainingClassSectionTranslation == null && (description != null || overview != null || introduction != null)) {
215            trainingControl.createTrainingClassSectionTranslation(trainingClassSection, getPreferredLanguage(), description, overviewMimeType, overview,
216                    introductionMimeType, introduction, partyPK);
217        } else if(trainingClassSectionTranslation != null && (description == null && overview == null && introduction == null)) {
218            trainingControl.deleteTrainingClassSectionTranslation(trainingClassSectionTranslation, partyPK);
219        } else if(trainingClassSectionTranslation != null && (description != null || overview != null || introduction != null)) {
220            var trainingClassSectionTranslationValue = trainingControl.getTrainingClassSectionTranslationValue(trainingClassSectionTranslation);
221
222            trainingClassSectionTranslationValue.setDescription(description);
223            trainingClassSectionTranslationValue.setOverviewMimeTypePK(overviewMimeType == null? null: overviewMimeType.getPrimaryKey());
224            trainingClassSectionTranslationValue.setOverview(overview);
225            trainingClassSectionTranslationValue.setIntroductionMimeTypePK(introductionMimeType == null? null: introductionMimeType.getPrimaryKey());
226            trainingClassSectionTranslationValue.setIntroduction(introduction);
227            trainingControl.updateTrainingClassSectionTranslationFromValue(trainingClassSectionTranslationValue, partyPK);
228        }
229    }
230
231}