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