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