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.TrainingClassQuestionTranslationEdit;
020import com.echothree.control.user.training.common.edit.TrainingEditFactory;
021import com.echothree.control.user.training.common.form.EditTrainingClassQuestionTranslationForm;
022import com.echothree.control.user.training.common.result.EditTrainingClassQuestionTranslationResult;
023import com.echothree.control.user.training.common.result.TrainingResultFactory;
024import com.echothree.control.user.training.common.spec.TrainingClassQuestionTranslationSpec;
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.TrainingClassQuestion;
034import com.echothree.model.data.training.server.entity.TrainingClassQuestionTranslation;
035import com.echothree.model.data.training.server.entity.TrainingClassSection;
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 com.echothree.util.server.persistence.Session;
046import java.util.List;
047import javax.enterprise.context.Dependent;
048
049@Dependent
050public class EditTrainingClassQuestionTranslationCommand
051        extends BaseAbstractEditCommand<TrainingClassQuestionTranslationSpec, TrainingClassQuestionTranslationEdit, EditTrainingClassQuestionTranslationResult, TrainingClassQuestionTranslation, TrainingClassQuestion> {
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.TrainingClassQuestion.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("LanguageIsoName", FieldType.ENTITY_NAME, true, null, null)
070                );
071
072        EDIT_FIELD_DEFINITIONS = List.of(
073                new FieldDefinition("QuestionMimeTypeName", FieldType.MIME_TYPE, true, null, null),
074                new FieldDefinition("Question", FieldType.STRING, true, null, null)
075                );
076    }
077
078    /** Creates a new instance of EditTrainingClassQuestionTranslationCommand */
079    public EditTrainingClassQuestionTranslationCommand() {
080        super(COMMAND_SECURITY_DEFINITION, SPEC_FIELD_DEFINITIONS, EDIT_FIELD_DEFINITIONS);
081    }
082
083    @Override
084    public EditTrainingClassQuestionTranslationResult getResult() {
085        return TrainingResultFactory.getEditTrainingClassQuestionTranslationResult();
086    }
087
088    @Override
089    public TrainingClassQuestionTranslationEdit getEdit() {
090        return TrainingEditFactory.getTrainingClassQuestionTranslationEdit();
091    }
092
093    TrainingClassSection trainingClassSection;
094    
095    @Override
096    public TrainingClassQuestionTranslation getEntity(EditTrainingClassQuestionTranslationResult result) {
097        var trainingControl = Session.getModelController(TrainingControl.class);
098        TrainingClassQuestionTranslation trainingClassQuestionTranslation = null;
099        var trainingClassName = spec.getTrainingClassName();
100        var trainingClass = trainingControl.getTrainingClassByName(trainingClassName);
101
102        if(trainingClass != null) {
103            var trainingClassSectionName = spec.getTrainingClassSectionName();
104            
105            trainingClassSection = trainingControl.getTrainingClassSectionByName(trainingClass, trainingClassSectionName);
106
107            if(trainingClassSection != null) {
108                var trainingClassQuestionName = spec.getTrainingClassQuestionName();
109                var trainingClassQuestion = trainingControl.getTrainingClassQuestionByName(trainingClassSection, trainingClassQuestionName);
110
111                if(trainingClassQuestion != null) {
112                    var partyControl = Session.getModelController(PartyControl.class);
113                    var languageIsoName = spec.getLanguageIsoName();
114                    var language = partyControl.getLanguageByIsoName(languageIsoName);
115
116                    if(language != null) {
117                        if(editMode.equals(EditMode.LOCK) || editMode.equals(EditMode.ABANDON)) {
118                            trainingClassQuestionTranslation = trainingControl.getTrainingClassQuestionTranslation(trainingClassQuestion, language);
119                        } else { // EditMode.UPDATE
120                            trainingClassQuestionTranslation = trainingControl.getTrainingClassQuestionTranslationForUpdate(trainingClassQuestion, language);
121                        }
122
123                        if(trainingClassQuestionTranslation == null) {
124                            addExecutionError(ExecutionErrors.UnknownTrainingClassQuestionTranslation.name(), trainingClassName, trainingClassSectionName,
125                                    trainingClassQuestionName, languageIsoName);
126                        }
127                    } else {
128                        addExecutionError(ExecutionErrors.UnknownLanguageIsoName.name(), languageIsoName);
129                    }
130                } else {
131                    addExecutionError(ExecutionErrors.UnknownTrainingClassQuestionName.name(), trainingClassName, trainingClassSectionName, trainingClassQuestionName);
132                }
133            } else {
134                addExecutionError(ExecutionErrors.UnknownTrainingClassSectionName.name(), trainingClassName, trainingClassSectionName);
135            }
136        } else {
137            addExecutionError(ExecutionErrors.UnknownTrainingClassName.name(), trainingClassName);
138        }
139
140        return trainingClassQuestionTranslation;
141    }
142
143    @Override
144    public TrainingClassQuestion getLockEntity(TrainingClassQuestionTranslation trainingClassQuestionTranslation) {
145        return trainingClassQuestionTranslation.getTrainingClassQuestion();
146    }
147
148    @Override
149    public void fillInResult(EditTrainingClassQuestionTranslationResult result, TrainingClassQuestionTranslation trainingClassQuestionTranslation) {
150        var trainingControl = Session.getModelController(TrainingControl.class);
151
152        result.setTrainingClassQuestionTranslation(trainingControl.getTrainingClassQuestionTranslationTransfer(getUserVisit(), trainingClassQuestionTranslation));
153    }
154
155    MimeType questionMimeType;
156    
157    @Override
158    public void doLock(TrainingClassQuestionTranslationEdit edit, TrainingClassQuestionTranslation trainingClassQuestionTranslation) {
159        questionMimeType = trainingClassQuestionTranslation.getQuestionMimeType();
160        
161        edit.setQuestionMimeTypeName(questionMimeType == null? null: questionMimeType.getLastDetail().getMimeTypeName());
162        edit.setQuestion(trainingClassQuestionTranslation.getQuestion());
163    }
164
165    @Override
166    protected void canUpdate(TrainingClassQuestionTranslation trainingClassQuestionTranslation) {
167        var mimeTypeLogic = MimeTypeLogic.getInstance();
168        var questionMimeTypeName = edit.getQuestionMimeTypeName();
169        var question = edit.getQuestion();
170        
171        questionMimeType = mimeTypeLogic.checkMimeType(this, questionMimeTypeName, question, MimeTypeUsageTypes.TEXT.name(),
172                ExecutionErrors.MissingRequiredQuestionMimeTypeName.name(), ExecutionErrors.MissingRequiredQuestion.name(),
173                ExecutionErrors.UnknownQuestionMimeTypeName.name(), ExecutionErrors.UnknownQuestionMimeTypeUsage.name());
174    }
175    
176    @Override
177    public void doUpdate(TrainingClassQuestionTranslation trainingClassQuestionTranslation) {
178        var trainingControl = Session.getModelController(TrainingControl.class);
179        var trainingClassQuestionTranslationValue = trainingControl.getTrainingClassQuestionTranslationValue(trainingClassQuestionTranslation);
180        
181        trainingClassQuestionTranslationValue.setQuestionMimeTypePK(questionMimeType.getPrimaryKey());
182        trainingClassQuestionTranslationValue.setQuestion(edit.getQuestion());
183        
184        trainingControl.updateTrainingClassQuestionTranslationFromValue(trainingClassQuestionTranslationValue, getPartyPK());
185    }
186
187}