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