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