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.persistence.Session;
044import com.echothree.util.server.string.PercentUtils;
045import java.util.List;
046import javax.enterprise.context.Dependent;
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    /** Creates a new instance of EditTrainingClassSectionCommand */
083    public EditTrainingClassSectionCommand() {
084        super(COMMAND_SECURITY_DEFINITION, SPEC_FIELD_DEFINITIONS, EDIT_FIELD_DEFINITIONS);
085    }
086    
087    @Override
088    public EditTrainingClassSectionResult getResult() {
089        return TrainingResultFactory.getEditTrainingClassSectionResult();
090    }
091
092    @Override
093    public TrainingClassSectionEdit getEdit() {
094        return TrainingEditFactory.getTrainingClassSectionEdit();
095    }
096
097    TrainingClass trainingClass;
098    
099    @Override
100    public TrainingClassSection getEntity(EditTrainingClassSectionResult result) {
101        var trainingControl = Session.getModelController(TrainingControl.class);
102        TrainingClassSection trainingClassSection = null;
103        var trainingClassName = spec.getTrainingClassName();
104
105        trainingClass = trainingControl.getTrainingClassByName(trainingClassName);
106
107        if(trainingClass != null) {
108            var trainingClassSectionName = spec.getTrainingClassSectionName();
109
110            if(editMode.equals(EditMode.LOCK) || editMode.equals(EditMode.ABANDON)) {
111                trainingClassSection = trainingControl.getTrainingClassSectionByName(trainingClass, trainingClassSectionName);
112            } else { // EditMode.UPDATE
113                trainingClassSection = trainingControl.getTrainingClassSectionByNameForUpdate(trainingClass, trainingClassSectionName);
114            }
115
116            if(trainingClassSection != null) {
117                result.setTrainingClassSection(trainingControl.getTrainingClassSectionTransfer(getUserVisit(), trainingClassSection));
118            } else {
119                addExecutionError(ExecutionErrors.UnknownTrainingClassSectionName.name(), trainingClassName, trainingClassSectionName);
120            }
121        } else {
122            addExecutionError(ExecutionErrors.UnknownTrainingClassName.name(), trainingClassName);
123        }
124
125        return trainingClassSection;
126    }
127
128    @Override
129    public TrainingClassSection getLockEntity(TrainingClassSection trainingClassSection) {
130        return trainingClassSection;
131    }
132
133    @Override
134    public void fillInResult(EditTrainingClassSectionResult result, TrainingClassSection trainingClassSection) {
135        var trainingControl = Session.getModelController(TrainingControl.class);
136
137        result.setTrainingClassSection(trainingControl.getTrainingClassSectionTransfer(getUserVisit(), trainingClassSection));
138    }
139
140    MimeType overviewMimeType;
141    MimeType introductionMimeType;
142    
143    @Override
144    public void doLock(TrainingClassSectionEdit edit, TrainingClassSection trainingClassSection) {
145        var trainingControl = Session.getModelController(TrainingControl.class);
146        var trainingClassSectionTranslation = trainingControl.getTrainingClassSectionTranslation(trainingClassSection, getPreferredLanguage());
147        var trainingClassSectionDetail = trainingClassSection.getLastDetail();
148        var questionCount = trainingClassSectionDetail.getQuestionCount();
149
150        edit.setTrainingClassSectionName(trainingClassSectionDetail.getTrainingClassSectionName());
151        edit.setPercentageToPass(PercentUtils.getInstance().formatFractionalPercent(trainingClassSectionDetail.getPercentageToPass()));
152        edit.setQuestionCount(questionCount == null? null: questionCount.toString());
153        edit.setSortOrder(trainingClassSectionDetail.getSortOrder().toString());
154
155        if(trainingClassSectionTranslation != null) {
156            overviewMimeType = trainingClassSectionTranslation.getOverviewMimeType();
157            introductionMimeType = trainingClassSectionTranslation.getIntroductionMimeType();
158
159            edit.setDescription(trainingClassSectionTranslation.getDescription());
160            edit.setOverviewMimeTypeName(overviewMimeType == null? null: overviewMimeType.getLastDetail().getMimeTypeName());
161            edit.setOverview(trainingClassSectionTranslation.getOverview());
162            edit.setIntroductionMimeTypeName(introductionMimeType == null? null: introductionMimeType.getLastDetail().getMimeTypeName());
163            edit.setIntroduction(trainingClassSectionTranslation.getIntroduction());
164        }
165    }
166
167    @Override
168    public void canUpdate(TrainingClassSection trainingClassSection) {
169        var trainingControl = Session.getModelController(TrainingControl.class);
170        var trainingClassSectionName = edit.getTrainingClassSectionName();
171        var duplicateTrainingClassSection = trainingControl.getTrainingClassSectionByName(trainingClass, trainingClassSectionName);
172
173        if(duplicateTrainingClassSection != null && !trainingClassSection.equals(duplicateTrainingClassSection)) {
174            addExecutionError(ExecutionErrors.DuplicateTrainingClassSectionName.name(), trainingClassSectionName);
175        } else {
176            var mimeTypeLogic = MimeTypeLogic.getInstance();
177            var overviewMimeTypeName = edit.getOverviewMimeTypeName();
178            var overview = edit.getOverview();
179
180            overviewMimeType = mimeTypeLogic.checkMimeType(this, overviewMimeTypeName, overview, MimeTypeUsageTypes.TEXT.name(),
181                    ExecutionErrors.MissingRequiredOverviewMimeTypeName.name(), ExecutionErrors.MissingRequiredOverview.name(),
182                    ExecutionErrors.UnknownOverviewMimeTypeName.name(), ExecutionErrors.UnknownOverviewMimeTypeUsage.name());
183
184            if(!hasExecutionErrors()) {
185                var introductionMimeTypeName = edit.getIntroductionMimeTypeName();
186                var introduction = edit.getIntroduction();
187
188                introductionMimeType = mimeTypeLogic.checkMimeType(this, introductionMimeTypeName, introduction, MimeTypeUsageTypes.TEXT.name(),
189                        ExecutionErrors.MissingRequiredIntroductionMimeTypeName.name(), ExecutionErrors.MissingRequiredIntroduction.name(),
190                        ExecutionErrors.UnknownIntroductionMimeTypeName.name(), ExecutionErrors.UnknownIntroductionMimeTypeUsage.name());
191            }
192        }
193    }
194    
195    @Override
196    public void doUpdate(TrainingClassSection trainingClassSection) {
197        var trainingControl = Session.getModelController(TrainingControl.class);
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}