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.GetTrainingClassAnswerTranslationForm;
020import com.echothree.control.user.training.common.result.GetTrainingClassAnswerTranslationResult;
021import com.echothree.control.user.training.common.result.TrainingResultFactory;
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.party.server.entity.Language;
028import com.echothree.model.data.training.server.entity.TrainingClass;
029import com.echothree.model.data.training.server.entity.TrainingClassAnswer;
030import com.echothree.model.data.training.server.entity.TrainingClassAnswerTranslation;
031import com.echothree.model.data.training.server.entity.TrainingClassQuestion;
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 GetTrainingClassAnswerTranslationCommand
048        extends BaseSimpleCommand<GetTrainingClassAnswerTranslationForm> {
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.TrainingClassAnswer.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("TrainingClassAnswerName", FieldType.ENTITY_NAME, true, null, null),
066                new FieldDefinition("LanguageIsoName", FieldType.ENTITY_NAME, true, null, null)
067                ));
068    }
069    
070    /** Creates a new instance of GetTrainingClassAnswerTranslationCommand */
071    public GetTrainingClassAnswerTranslationCommand(UserVisitPK userVisitPK, GetTrainingClassAnswerTranslationForm form) {
072        super(userVisitPK, form, COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
073    }
074    
075    @Override
076    protected BaseResult execute() {
077        var trainingControl = Session.getModelController(TrainingControl.class);
078        GetTrainingClassAnswerTranslationResult result = TrainingResultFactory.getGetTrainingClassAnswerTranslationResult();
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                    String trainingClassAnswerName = form.getTrainingClassAnswerName();
092                    TrainingClassAnswer trainingClassAnswer = trainingControl.getTrainingClassAnswerByName(trainingClassQuestion, trainingClassAnswerName);
093
094                    if(trainingClassAnswer != null) {
095                        var partyControl = Session.getModelController(PartyControl.class);
096                        String languageIsoName = form.getLanguageIsoName();
097                        Language language = partyControl.getLanguageByIsoName(languageIsoName);
098
099                        if(language != null) {
100                            TrainingClassAnswerTranslation trainingClassAnswerTranslation = trainingControl.getTrainingClassAnswerTranslation(trainingClassAnswer, language);
101
102                            if(trainingClassAnswerTranslation != null) {
103                                result.setTrainingClassAnswerTranslation(trainingControl.getTrainingClassAnswerTranslationTransfer(getUserVisit(),
104                                        trainingClassAnswerTranslation));
105                            } else {
106                                addExecutionError(ExecutionErrors.UnknownTrainingClassAnswerTranslation.name(), trainingClassName, trainingClassSectionName,
107                                        trainingClassQuestionName, trainingClassAnswerName, languageIsoName);
108                            }
109                        } else {
110                            addExecutionError(ExecutionErrors.UnknownLanguageIsoName.name(), languageIsoName);
111                        }
112                    } else {
113                        addExecutionError(ExecutionErrors.UnknownTrainingClassAnswerName.name(), trainingClassName, trainingClassSectionName,
114                                trainingClassQuestionName, trainingClassAnswerName);
115                    }
116                } else {
117                    addExecutionError(ExecutionErrors.UnknownTrainingClassQuestionName.name(), trainingClassName, trainingClassSectionName,
118                            trainingClassQuestionName);
119                }
120            } else {
121                addExecutionError(ExecutionErrors.UnknownTrainingClassSectionName.name(), trainingClassName, trainingClassSectionName);
122            }
123        } else {
124            addExecutionError(ExecutionErrors.UnknownTrainingClassName.name(), trainingClassName);
125        }
126
127        return result;
128    }
129    
130}