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.form.CreateTrainingClassAnswerTranslationForm;
020import com.echothree.model.control.core.common.MimeTypeUsageTypes;
021import com.echothree.model.control.core.server.logic.MimeTypeLogic;
022import com.echothree.model.control.party.common.PartyTypes;
023import com.echothree.model.control.party.server.control.PartyControl;
024import com.echothree.model.control.security.common.SecurityRoleGroups;
025import com.echothree.model.control.security.common.SecurityRoles;
026import com.echothree.model.control.training.server.control.TrainingControl;
027import com.echothree.model.data.core.server.entity.MimeType;
028import com.echothree.model.data.party.server.entity.Language;
029import com.echothree.model.data.training.server.entity.TrainingClass;
030import com.echothree.model.data.training.server.entity.TrainingClassAnswer;
031import com.echothree.model.data.training.server.entity.TrainingClassAnswerTranslation;
032import com.echothree.model.data.training.server.entity.TrainingClassQuestion;
033import com.echothree.model.data.training.server.entity.TrainingClassSection;
034import com.echothree.model.data.user.common.pk.UserVisitPK;
035import com.echothree.util.common.message.ExecutionErrors;
036import com.echothree.util.common.validation.FieldDefinition;
037import com.echothree.util.common.validation.FieldType;
038import com.echothree.util.common.command.BaseResult;
039import com.echothree.util.server.control.BaseSimpleCommand;
040import com.echothree.util.server.control.CommandSecurityDefinition;
041import com.echothree.util.server.control.PartyTypeDefinition;
042import com.echothree.util.server.control.SecurityRoleDefinition;
043import com.echothree.util.server.persistence.Session;
044import java.util.Arrays;
045import java.util.Collections;
046import java.util.List;
047
048public class CreateTrainingClassAnswerTranslationCommand
049        extends BaseSimpleCommand<CreateTrainingClassAnswerTranslationForm> {
050    
051    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
052    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
053    
054    static {
055        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(Collections.unmodifiableList(Arrays.asList(
056                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
057                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), Collections.unmodifiableList(Arrays.asList(
058                        new SecurityRoleDefinition(SecurityRoleGroups.TrainingClassAnswer.name(), SecurityRoles.Translation.name())
059                        )))
060                )));
061
062        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
063                new FieldDefinition("TrainingClassName", FieldType.ENTITY_NAME, true, null, null),
064                new FieldDefinition("TrainingClassSectionName", FieldType.ENTITY_NAME, true, null, null),
065                new FieldDefinition("TrainingClassQuestionName", FieldType.ENTITY_NAME, true, null, null),
066                new FieldDefinition("TrainingClassAnswerName", FieldType.ENTITY_NAME, true, null, null),
067                new FieldDefinition("LanguageIsoName", FieldType.ENTITY_NAME, true, null, null),
068                new FieldDefinition("AnswerMimeTypeName", FieldType.MIME_TYPE, true, null, null),
069                new FieldDefinition("Answer", FieldType.STRING, true, null, null),
070                new FieldDefinition("SelectedMimeTypeName", FieldType.MIME_TYPE, false, null, null),
071                new FieldDefinition("Selected", FieldType.STRING, false, null, null)
072                ));
073    }
074    
075    /** Creates a new instance of CreateTrainingClassAnswerTranslationCommand */
076    public CreateTrainingClassAnswerTranslationCommand(UserVisitPK userVisitPK, CreateTrainingClassAnswerTranslationForm form) {
077        super(userVisitPK, form, COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
078    }
079    
080    @Override
081    protected BaseResult execute() {
082        var trainingControl = Session.getModelController(TrainingControl.class);
083        String trainingClassName = form.getTrainingClassName();
084        TrainingClass trainingClass = trainingControl.getTrainingClassByName(trainingClassName);
085
086        if(trainingClass != null) {
087            String trainingClassSectionName = form.getTrainingClassSectionName();
088            TrainingClassSection trainingClassSection = trainingControl.getTrainingClassSectionByName(trainingClass, trainingClassSectionName);
089
090            if(trainingClassSection != null) {
091                String trainingClassQuestionName = form.getTrainingClassQuestionName();
092                TrainingClassQuestion trainingClassQuestion = trainingControl.getTrainingClassQuestionByName(trainingClassSection, trainingClassQuestionName);
093
094                if(trainingClassQuestion != null) {
095                    String trainingClassAnswerName = form.getTrainingClassAnswerName();
096                    TrainingClassAnswer trainingClassAnswer = trainingControl.getTrainingClassAnswerByName(trainingClassQuestion, trainingClassAnswerName);
097
098                    if(trainingClassAnswer != null) {
099                        var partyControl = Session.getModelController(PartyControl.class);
100                        String languageIsoName = form.getLanguageIsoName();
101                        Language language = partyControl.getLanguageByIsoName(languageIsoName);
102
103                        if(language != null) {
104                            TrainingClassAnswerTranslation trainingClassAnswerTranslation = trainingControl.getTrainingClassAnswerTranslation(trainingClassAnswer, language);
105
106                            if(trainingClassAnswerTranslation == null) {
107                                MimeTypeLogic mimeTypeLogic = MimeTypeLogic.getInstance();
108                                String answerMimeTypeName = form.getAnswerMimeTypeName();
109                                String answer = form.getAnswer();
110
111                                MimeType answerMimeType = mimeTypeLogic.checkMimeType(this, answerMimeTypeName, answer, MimeTypeUsageTypes.TEXT.name(),
112                                        ExecutionErrors.MissingRequiredAnswerMimeTypeName.name(), ExecutionErrors.MissingRequiredAnswer.name(),
113                                        ExecutionErrors.UnknownAnswerMimeTypeName.name(), ExecutionErrors.UnknownAnswerMimeTypeUsage.name());
114
115                                if(!hasExecutionErrors()) {
116                                    String selected = form.getSelected();
117                                    MimeType selectedMimeType = mimeTypeLogic.checkMimeType(this, form.getSelectedMimeTypeName(), selected, MimeTypeUsageTypes.TEXT.name(),
118                                            ExecutionErrors.MissingRequiredSelectedMimeTypeName.name(), ExecutionErrors.MissingRequiredSelected.name(),
119                                            ExecutionErrors.UnknownSelectedMimeTypeName.name(), ExecutionErrors.UnknownSelectedMimeTypeUsage.name());
120
121                                    if(!hasExecutionErrors()) {
122                                        trainingControl.createTrainingClassAnswerTranslation(trainingClassAnswer, language, answerMimeType, answer,
123                                                selectedMimeType, selected, getPartyPK());
124                                    }
125                                }
126                            } else {
127                                addExecutionError(ExecutionErrors.DuplicateTrainingClassAnswerTranslation.name(), trainingClassName, trainingClassSectionName,
128                                        trainingClassQuestionName, trainingClassAnswerName, languageIsoName);
129                            }
130                        } else {
131                            addExecutionError(ExecutionErrors.UnknownLanguageIsoName.name(), languageIsoName);
132                        }
133                    } else {
134                        addExecutionError(ExecutionErrors.UnknownTrainingClassAnswerName.name(), trainingClassName, trainingClassSectionName,
135                                trainingClassQuestionName, trainingClassAnswerName);
136                    }
137                } else {
138                    addExecutionError(ExecutionErrors.UnknownTrainingClassQuestionName.name(), trainingClassName, trainingClassSectionName,
139                            trainingClassQuestionName);
140                }
141            } else {
142                addExecutionError(ExecutionErrors.UnknownTrainingClassSectionName.name(), trainingClassName, trainingClassSectionName);
143            }
144        } else {
145            addExecutionError(ExecutionErrors.UnknownTrainingClassName.name(), trainingClassName);
146        }
147
148        return null;
149    }
150    
151}