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.CreateTrainingClassQuestionTranslationForm;
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.TrainingClassQuestion;
031import com.echothree.model.data.training.server.entity.TrainingClassQuestionTranslation;
032import com.echothree.model.data.training.server.entity.TrainingClassSection;
033import com.echothree.model.data.user.common.pk.UserVisitPK;
034import com.echothree.util.common.message.ExecutionErrors;
035import com.echothree.util.common.validation.FieldDefinition;
036import com.echothree.util.common.validation.FieldType;
037import com.echothree.util.common.command.BaseResult;
038import com.echothree.util.server.control.BaseSimpleCommand;
039import com.echothree.util.server.control.CommandSecurityDefinition;
040import com.echothree.util.server.control.PartyTypeDefinition;
041import com.echothree.util.server.control.SecurityRoleDefinition;
042import com.echothree.util.server.persistence.Session;
043import java.util.Arrays;
044import java.util.Collections;
045import java.util.List;
046
047public class CreateTrainingClassQuestionTranslationCommand
048        extends BaseSimpleCommand<CreateTrainingClassQuestionTranslationForm> {
049    
050    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
051    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
052    
053    static {
054        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(Collections.unmodifiableList(Arrays.asList(
055                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
056                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), Collections.unmodifiableList(Arrays.asList(
057                        new SecurityRoleDefinition(SecurityRoleGroups.TrainingClassQuestion.name(), SecurityRoles.Translation.name())
058                        )))
059                )));
060
061        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
062                new FieldDefinition("TrainingClassName", FieldType.ENTITY_NAME, true, null, null),
063                new FieldDefinition("TrainingClassSectionName", FieldType.ENTITY_NAME, true, null, null),
064                new FieldDefinition("TrainingClassQuestionName", FieldType.ENTITY_NAME, true, null, null),
065                new FieldDefinition("LanguageIsoName", FieldType.ENTITY_NAME, true, null, null),
066                new FieldDefinition("QuestionMimeTypeName", FieldType.MIME_TYPE, true, null, null),
067                new FieldDefinition("Question", FieldType.STRING, true, null, null)
068                ));
069    }
070    
071    /** Creates a new instance of CreateTrainingClassQuestionTranslationCommand */
072    public CreateTrainingClassQuestionTranslationCommand(UserVisitPK userVisitPK, CreateTrainingClassQuestionTranslationForm form) {
073        super(userVisitPK, form, COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
074    }
075    
076    @Override
077    protected BaseResult execute() {
078        var trainingControl = Session.getModelController(TrainingControl.class);
079        String trainingClassName = form.getTrainingClassName();
080        TrainingClass trainingClass = trainingControl.getTrainingClassByName(trainingClassName);
081
082        if(trainingClass != null) {
083            String trainingClassSectionName = form.getTrainingClassSectionName();
084            TrainingClassSection trainingClassSection = trainingControl.getTrainingClassSectionByName(trainingClass, trainingClassSectionName);
085
086            if(trainingClassSection != null) {
087                String trainingClassQuestionName = form.getTrainingClassQuestionName();
088                TrainingClassQuestion trainingClassQuestion = trainingControl.getTrainingClassQuestionByName(trainingClassSection, trainingClassQuestionName);
089
090                if(trainingClassQuestion != null) {
091                    var partyControl = Session.getModelController(PartyControl.class);
092                    String languageIsoName = form.getLanguageIsoName();
093                    Language language = partyControl.getLanguageByIsoName(languageIsoName);
094
095                    if(language != null) {
096                        TrainingClassQuestionTranslation trainingClassQuestionTranslation = trainingControl.getTrainingClassQuestionTranslation(trainingClassQuestion, language);
097
098                        if(trainingClassQuestionTranslation == null) {
099                            MimeTypeLogic mimeTypeLogic = MimeTypeLogic.getInstance();
100                            String questionMimeTypeName = form.getQuestionMimeTypeName();
101                            String question = form.getQuestion();
102
103                            MimeType questionMimeType = mimeTypeLogic.checkMimeType(this, questionMimeTypeName, question, MimeTypeUsageTypes.TEXT.name(),
104                                    ExecutionErrors.MissingRequiredQuestionMimeTypeName.name(), ExecutionErrors.MissingRequiredQuestion.name(),
105                                    ExecutionErrors.UnknownQuestionMimeTypeName.name(), ExecutionErrors.UnknownQuestionMimeTypeUsage.name());
106
107                            if(!hasExecutionErrors()) {
108                                trainingControl.createTrainingClassQuestionTranslation(trainingClassQuestion, language, questionMimeType, question,
109                                        getPartyPK());
110                            }
111                        } else {
112                            addExecutionError(ExecutionErrors.DuplicateTrainingClassQuestionTranslation.name(), trainingClassName, trainingClassSectionName,
113                                    trainingClassQuestionName, languageIsoName);
114                        }
115                    } else {
116                        addExecutionError(ExecutionErrors.UnknownLanguageIsoName.name(), languageIsoName);
117                    }
118                } else {
119                    addExecutionError(ExecutionErrors.UnknownTrainingClassQuestionName.name(), trainingClassName, trainingClassSectionName,
120                            trainingClassQuestionName);
121                }
122            } else {
123                addExecutionError(ExecutionErrors.UnknownTrainingClassSectionName.name(), trainingClassName, trainingClassSectionName);
124            }
125        } else {
126            addExecutionError(ExecutionErrors.UnknownTrainingClassName.name(), trainingClassName);
127        }
128
129        return null;
130    }
131    
132}