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.TrainingClassAnswerTranslationEdit;
020import com.echothree.control.user.training.common.edit.TrainingEditFactory;
021import com.echothree.control.user.training.common.form.EditTrainingClassAnswerTranslationForm;
022import com.echothree.control.user.training.common.result.EditTrainingClassAnswerTranslationResult;
023import com.echothree.control.user.training.common.result.TrainingResultFactory;
024import com.echothree.control.user.training.common.spec.TrainingClassAnswerTranslationSpec;
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.party.server.control.PartyControl;
029import com.echothree.model.control.security.common.SecurityRoleGroups;
030import com.echothree.model.control.security.common.SecurityRoles;
031import com.echothree.model.control.training.server.control.TrainingControl;
032import com.echothree.model.data.core.server.entity.MimeType;
033import com.echothree.model.data.training.server.entity.TrainingClassAnswer;
034import com.echothree.model.data.training.server.entity.TrainingClassAnswerTranslation;
035import com.echothree.model.data.training.server.entity.TrainingClassQuestion;
036import com.echothree.model.data.user.common.pk.UserVisitPK;
037import com.echothree.util.common.message.ExecutionErrors;
038import com.echothree.util.common.validation.FieldDefinition;
039import com.echothree.util.common.validation.FieldType;
040import com.echothree.util.common.command.EditMode;
041import com.echothree.util.server.control.BaseAbstractEditCommand;
042import com.echothree.util.server.control.CommandSecurityDefinition;
043import com.echothree.util.server.control.PartyTypeDefinition;
044import com.echothree.util.server.control.SecurityRoleDefinition;
045import java.util.List;
046import javax.enterprise.context.Dependent;
047import javax.inject.Inject;
048
049@Dependent
050public class EditTrainingClassAnswerTranslationCommand
051        extends BaseAbstractEditCommand<TrainingClassAnswerTranslationSpec, TrainingClassAnswerTranslationEdit, EditTrainingClassAnswerTranslationResult, TrainingClassAnswerTranslation, TrainingClassAnswer> {
052
053    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
054    private final static List<FieldDefinition> SPEC_FIELD_DEFINITIONS;
055    private final static List<FieldDefinition> EDIT_FIELD_DEFINITIONS;
056
057    static {
058        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(List.of(
059                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
060                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
061                        new SecurityRoleDefinition(SecurityRoleGroups.TrainingClassAnswer.name(), SecurityRoles.Translation.name())
062                ))
063        ));
064
065        SPEC_FIELD_DEFINITIONS = List.of(
066                new FieldDefinition("TrainingClassName", FieldType.ENTITY_NAME, true, null, null),
067                new FieldDefinition("TrainingClassSectionName", FieldType.ENTITY_NAME, true, null, null),
068                new FieldDefinition("TrainingClassQuestionName", FieldType.ENTITY_NAME, true, null, null),
069                new FieldDefinition("TrainingClassAnswerName", FieldType.ENTITY_NAME, true, null, null),
070                new FieldDefinition("LanguageIsoName", FieldType.ENTITY_NAME, true, null, null)
071        );
072
073        EDIT_FIELD_DEFINITIONS = List.of(
074                new FieldDefinition("AnswerMimeTypeName", FieldType.MIME_TYPE, true, null, null),
075                new FieldDefinition("Answer", FieldType.STRING, true, null, null),
076                new FieldDefinition("SelectedMimeTypeName", FieldType.MIME_TYPE, false, null, null),
077                new FieldDefinition("Selected", FieldType.STRING, false, null, null)
078        );
079    }
080
081    @Inject
082    PartyControl partyControl;
083
084    @Inject
085    TrainingControl trainingControl;
086
087    @Inject
088    MimeTypeLogic mimeTypeLogic;
089
090    /** Creates a new instance of EditTrainingClassAnswerTranslationCommand */
091    public EditTrainingClassAnswerTranslationCommand() {
092        super(COMMAND_SECURITY_DEFINITION, SPEC_FIELD_DEFINITIONS, EDIT_FIELD_DEFINITIONS);
093    }
094
095    @Override
096    public EditTrainingClassAnswerTranslationResult getResult() {
097        return TrainingResultFactory.getEditTrainingClassAnswerTranslationResult();
098    }
099
100    @Override
101    public TrainingClassAnswerTranslationEdit getEdit() {
102        return TrainingEditFactory.getTrainingClassAnswerTranslationEdit();
103    }
104
105   TrainingClassQuestion trainingClassQuestion;
106    
107    @Override
108    public TrainingClassAnswerTranslation getEntity(EditTrainingClassAnswerTranslationResult result) {
109        TrainingClassAnswerTranslation trainingClassAnswerTranslation = null;
110        var trainingClassName = spec.getTrainingClassName();
111        var trainingClass = trainingControl.getTrainingClassByName(trainingClassName);
112
113        if(trainingClass != null) {
114            var trainingClassSectionName = spec.getTrainingClassSectionName();
115            var trainingClassSection = trainingControl.getTrainingClassSectionByName(trainingClass, trainingClassSectionName);
116
117            if(trainingClassSection != null) {
118                var trainingClassQuestionName = spec.getTrainingClassQuestionName();
119                
120                trainingClassQuestion = trainingControl.getTrainingClassQuestionByName(trainingClassSection, trainingClassQuestionName);
121
122                if(trainingClassQuestion != null) {
123                    var trainingClassAnswerName = spec.getTrainingClassAnswerName();
124                    var trainingClassAnswer = trainingControl.getTrainingClassAnswerByName(trainingClassQuestion, trainingClassAnswerName);
125
126                    if(trainingClassAnswer != null) {
127                        var languageIsoName = spec.getLanguageIsoName();
128                        var language = partyControl.getLanguageByIsoName(languageIsoName);
129
130                        if(language != null) {
131                            if(editMode.equals(EditMode.LOCK) || editMode.equals(EditMode.ABANDON)) {
132                                trainingClassAnswerTranslation = trainingControl.getTrainingClassAnswerTranslation(trainingClassAnswer, language);
133                            } else { // EditMode.UPDATE
134                                trainingClassAnswerTranslation = trainingControl.getTrainingClassAnswerTranslationForUpdate(trainingClassAnswer, language);
135                            }
136
137                            if(trainingClassAnswerTranslation == null) {
138                                addExecutionError(ExecutionErrors.UnknownTrainingClassAnswerTranslation.name(), trainingClassName, trainingClassSectionName,
139                                        trainingClassQuestionName, trainingClassAnswerName, languageIsoName);
140                            }
141                        } else {
142                            addExecutionError(ExecutionErrors.UnknownLanguageIsoName.name(), languageIsoName);
143                        }
144                    } else {
145                        addExecutionError(ExecutionErrors.UnknownTrainingClassAnswerName.name(), trainingClassName, trainingClassSectionName,
146                                trainingClassQuestionName, trainingClassAnswerName);
147                    }
148                } else {
149                    addExecutionError(ExecutionErrors.UnknownTrainingClassQuestionName.name(), trainingClassName, trainingClassSectionName,
150                            trainingClassQuestionName);
151                }
152            } else {
153                addExecutionError(ExecutionErrors.UnknownTrainingClassSectionName.name(), trainingClassName, trainingClassSectionName);
154            }
155        } else {
156            addExecutionError(ExecutionErrors.UnknownTrainingClassName.name(), trainingClassName);
157        }
158
159        return trainingClassAnswerTranslation;
160    }
161
162    @Override
163    public TrainingClassAnswer getLockEntity(TrainingClassAnswerTranslation trainingClassAnswerTranslation) {
164        return trainingClassAnswerTranslation.getTrainingClassAnswer();
165    }
166
167    @Override
168    public void fillInResult(EditTrainingClassAnswerTranslationResult result, TrainingClassAnswerTranslation trainingClassAnswerTranslation) {
169        result.setTrainingClassAnswerTranslation(trainingControl.getTrainingClassAnswerTranslationTransfer(getUserVisit(), trainingClassAnswerTranslation));
170    }
171
172    MimeType answerMimeType;
173    MimeType selectedMimeType;
174    
175    @Override
176    public void doLock(TrainingClassAnswerTranslationEdit edit, TrainingClassAnswerTranslation trainingClassAnswerTranslation) {
177        answerMimeType = trainingClassAnswerTranslation.getAnswerMimeType();
178        selectedMimeType = trainingClassAnswerTranslation.getSelectedMimeType();
179        
180        edit.setAnswerMimeTypeName(answerMimeType == null? null: answerMimeType.getLastDetail().getMimeTypeName());
181        edit.setAnswer(trainingClassAnswerTranslation.getAnswer());
182        edit.setSelectedMimeTypeName(selectedMimeType == null? null: selectedMimeType.getLastDetail().getMimeTypeName());
183        edit.setSelected(trainingClassAnswerTranslation.getSelected());
184    }
185
186    @Override
187    protected void canUpdate(TrainingClassAnswerTranslation trainingClassAnswerTranslation) {
188        var answerMimeTypeName = edit.getAnswerMimeTypeName();
189        var answer = edit.getAnswer();
190        
191        answerMimeType = mimeTypeLogic.checkMimeType(this, answerMimeTypeName, answer, MimeTypeUsageTypes.TEXT.name(),
192                ExecutionErrors.MissingRequiredAnswerMimeTypeName.name(), ExecutionErrors.MissingRequiredAnswer.name(),
193                ExecutionErrors.UnknownAnswerMimeTypeName.name(), ExecutionErrors.UnknownAnswerMimeTypeUsage.name());
194        
195        if(!hasExecutionErrors()) {
196            var selectedMimeTypeName = edit.getSelectedMimeTypeName();
197            var selected = edit.getSelected();
198
199            selectedMimeType = mimeTypeLogic.checkMimeType(this, selectedMimeTypeName, selected, MimeTypeUsageTypes.TEXT.name(),
200                    ExecutionErrors.MissingRequiredSelectedMimeTypeName.name(), ExecutionErrors.MissingRequiredSelected.name(),
201                    ExecutionErrors.UnknownSelectedMimeTypeName.name(), ExecutionErrors.UnknownSelectedMimeTypeUsage.name());
202        }
203    }
204    
205    @Override
206    public void doUpdate(TrainingClassAnswerTranslation trainingClassAnswerTranslation) {
207        var trainingClassAnswerTranslationValue = trainingControl.getTrainingClassAnswerTranslationValue(trainingClassAnswerTranslation);
208        
209        trainingClassAnswerTranslationValue.setAnswerMimeTypePK(answerMimeType == null? null: answerMimeType.getPrimaryKey());
210        trainingClassAnswerTranslationValue.setAnswer(edit.getAnswer());
211        trainingClassAnswerTranslationValue.setSelectedMimeTypePK(selectedMimeType == null? null: selectedMimeType.getPrimaryKey());
212        trainingClassAnswerTranslationValue.setSelected(edit.getSelected());
213        
214        trainingControl.updateTrainingClassAnswerTranslationFromValue(trainingClassAnswerTranslationValue, getPartyPK());
215    }
216
217}