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