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