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.GetTrainingClassAnswersForm;
020import com.echothree.control.user.training.common.result.GetTrainingClassAnswersResult;
021import com.echothree.control.user.training.common.result.TrainingResultFactory;
022import com.echothree.model.control.party.common.PartyTypes;
023import com.echothree.model.control.security.common.SecurityRoleGroups;
024import com.echothree.model.control.security.common.SecurityRoles;
025import com.echothree.model.control.training.server.control.TrainingControl;
026import com.echothree.model.data.training.server.entity.TrainingClass;
027import com.echothree.model.data.training.server.entity.TrainingClassQuestion;
028import com.echothree.model.data.training.server.entity.TrainingClassSection;
029import com.echothree.model.data.user.common.pk.UserVisitPK;
030import com.echothree.model.data.user.server.entity.UserVisit;
031import com.echothree.util.common.message.ExecutionErrors;
032import com.echothree.util.common.validation.FieldDefinition;
033import com.echothree.util.common.validation.FieldType;
034import com.echothree.util.common.command.BaseResult;
035import com.echothree.util.server.control.BaseSimpleCommand;
036import com.echothree.util.server.control.CommandSecurityDefinition;
037import com.echothree.util.server.control.PartyTypeDefinition;
038import com.echothree.util.server.control.SecurityRoleDefinition;
039import com.echothree.util.server.persistence.Session;
040import java.util.Arrays;
041import java.util.Collections;
042import java.util.List;
043
044public class GetTrainingClassAnswersCommand
045        extends BaseSimpleCommand<GetTrainingClassAnswersForm> {
046    
047    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
048    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
049    
050    static {
051        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(Collections.unmodifiableList(Arrays.asList(
052                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
053                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), Collections.unmodifiableList(Arrays.asList(
054                        new SecurityRoleDefinition(SecurityRoleGroups.TrainingClassAnswer.name(), SecurityRoles.List.name())
055                        )))
056                )));
057
058        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
059                new FieldDefinition("TrainingClassName", FieldType.ENTITY_NAME, true, null, null),
060                new FieldDefinition("TrainingClassSectionName", FieldType.ENTITY_NAME, true, null, null),
061                new FieldDefinition("TrainingClassQuestionName", FieldType.ENTITY_NAME, true, null, null)
062                ));
063    }
064    
065    /** Creates a new instance of GetTrainingClassAnswersCommand */
066    public GetTrainingClassAnswersCommand(UserVisitPK userVisitPK, GetTrainingClassAnswersForm form) {
067        super(userVisitPK, form, COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, true);
068    }
069    
070    @Override
071    protected BaseResult execute() {
072        var trainingControl = Session.getModelController(TrainingControl.class);
073        GetTrainingClassAnswersResult result = TrainingResultFactory.getGetTrainingClassAnswersResult();
074        String trainingClassName = form.getTrainingClassName();
075        TrainingClass trainingClass = trainingControl.getTrainingClassByName(trainingClassName);
076
077        if(trainingClass != null) {
078            String trainingClassSectionName = form.getTrainingClassSectionName();
079            TrainingClassSection trainingClassSection = trainingControl.getTrainingClassSectionByName(trainingClass, trainingClassSectionName);
080
081            if(trainingClassSection != null) {
082                String trainingClassQuestionName = form.getTrainingClassQuestionName();
083                TrainingClassQuestion trainingClassQuestion = trainingControl.getTrainingClassQuestionByName(trainingClassSection, trainingClassQuestionName);
084
085                if(trainingClassQuestion != null) {
086                    UserVisit userVisit = getUserVisit();
087                    
088                    result.setTrainingClassQuestion(trainingControl.getTrainingClassQuestionTransfer(userVisit, trainingClassQuestion));
089                    result.setTrainingClassAnswers(trainingControl.getTrainingClassAnswerTransfers(getUserVisit(), trainingClassQuestion));
090                } else {
091                    addExecutionError(ExecutionErrors.UnknownTrainingClassQuestionName.name(), trainingClassName, trainingClassSectionName,
092                            trainingClassQuestionName);
093                }
094            } else {
095                addExecutionError(ExecutionErrors.UnknownTrainingClassSectionName.name(), trainingClassName, trainingClassSectionName);
096            }
097        } else {
098            addExecutionError(ExecutionErrors.UnknownTrainingClassName.name(), trainingClassName);
099        }
100
101        return result;
102    }
103    
104}