001// --------------------------------------------------------------------------------
002// Copyright 2002-2026 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.GetTrainingClassQuestionForm;
020import com.echothree.control.user.training.common.result.TrainingResultFactory;
021import com.echothree.model.control.core.common.EventTypes;
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.control.training.server.logic.PartyTrainingClassSessionLogic;
027import com.echothree.util.common.message.ExecutionErrors;
028import com.echothree.util.common.validation.FieldDefinition;
029import com.echothree.util.common.validation.FieldType;
030import com.echothree.util.common.command.BaseResult;
031import com.echothree.util.server.control.BaseSimpleCommand;
032import com.echothree.util.server.control.CommandSecurityDefinition;
033import com.echothree.util.server.control.PartyTypeDefinition;
034import com.echothree.util.server.control.SecurityRoleDefinition;
035import java.util.List;
036import javax.enterprise.context.Dependent;
037import javax.inject.Inject;
038
039@Dependent
040public class GetTrainingClassQuestionCommand
041        extends BaseSimpleCommand<GetTrainingClassQuestionForm> {
042    
043    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
044    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
045    
046    static {
047        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(List.of(
048                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
049                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
050                        new SecurityRoleDefinition(SecurityRoleGroups.TrainingClassQuestion.name(), SecurityRoles.Review.name())
051                ))
052        ));
053
054        FORM_FIELD_DEFINITIONS = List.of(
055                new FieldDefinition("TrainingClassName", FieldType.ENTITY_NAME, true, null, null),
056                new FieldDefinition("TrainingClassSectionName", FieldType.ENTITY_NAME, true, null, null),
057                new FieldDefinition("TrainingClassQuestionName", FieldType.ENTITY_NAME, true, null, null),
058                new FieldDefinition("PartyTrainingClassName", FieldType.ENTITY_NAME, false, null, null)
059        );
060    }
061
062    @Inject
063    TrainingControl trainingControl;
064
065    @Inject
066    PartyTrainingClassSessionLogic partyTrainingClassSessionLogic;
067
068    
069    /** Creates a new instance of GetTrainingClassQuestionCommand */
070    public GetTrainingClassQuestionCommand() {
071        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, true);
072    }
073    
074    @Override
075    protected BaseResult execute() {
076        var result = TrainingResultFactory.getGetTrainingClassQuestionResult();
077        var trainingClassName = form.getTrainingClassName();
078        var trainingClass = trainingControl.getTrainingClassByName(trainingClassName);
079
080        if(trainingClass != null) {
081            var trainingClassSectionName = form.getTrainingClassSectionName();
082            var trainingClassSection = trainingControl.getTrainingClassSectionByName(trainingClass, trainingClassSectionName);
083
084            if(trainingClassSection != null) {
085                var trainingClassQuestionName = form.getTrainingClassQuestionName();
086                var trainingClassQuestion = trainingControl.getTrainingClassQuestionByName(trainingClassSection, trainingClassQuestionName);
087
088                if(trainingClassQuestion != null) {
089                    var partyTrainingClassName = form.getPartyTrainingClassName();
090                    var partyTrainingClassSessionStatus = partyTrainingClassName == null ? null
091                            : partyTrainingClassSessionLogic.getLatestPartyTrainingClassSessionStatusForUpdate(this, partyTrainingClassName);
092                    
093                    if(!hasExecutionErrors()) {
094                        var partyTrainingClassSession = partyTrainingClassSessionStatus == null ? null
095                                : partyTrainingClassSessionStatus.getPartyTrainingClassSession();
096                        
097                        // Verify that the TrainingClass from above is same as the one being used by the PartyTrainingClassSession.
098                        if(partyTrainingClassSession != null) {
099                            if(!trainingClass.equals(partyTrainingClassSession.getLastDetail().getPartyTrainingClass().getLastDetail().getTrainingClass())) {
100                                addExecutionError(ExecutionErrors.InvalidPartyTrainingClass.name(), partyTrainingClassName);
101                            }
102                        }
103                        
104                        if(!hasExecutionErrors()) {
105                            var userVisit = getUserVisit();
106                            var partyPK = getPartyPK();
107
108                            result.setTrainingClassQuestion(trainingControl.getTrainingClassQuestionTransfer(userVisit, trainingClassQuestion));
109
110                            sendEvent(trainingClassQuestion.getPrimaryKey(), EventTypes.READ, null, null, partyPK);
111
112                            if(partyTrainingClassSessionStatus != null) {
113                                var partyTrainingClassSessionQuestion = trainingControl.getPartyTrainingClassSessionQuestion(partyTrainingClassSession, trainingClassQuestion);
114
115                                // If there isn't an existing PartyTrainingClassSessionQuestion, then we'll create one to attach the Answer to.
116                                if(partyTrainingClassSessionQuestion == null) {
117                                    partyTrainingClassSessionQuestion = trainingControl.createPartyTrainingClassSessionQuestion(partyTrainingClassSessionStatus.getPartyTrainingClassSession(),
118                                            trainingClassQuestion, null, partyPK);
119                                }
120
121                                var partyTrainingClassSessionAnswer = trainingControl.createPartyTrainingClassSessionAnswer(partyTrainingClassSessionQuestion,
122                                        null, session.getStartTime(), null, partyPK);
123
124                                partyTrainingClassSessionLogic.updatePartyTrainingClassSessionStatus(session, partyTrainingClassSessionStatus,
125                                        null, null, partyTrainingClassSessionQuestion);
126                                
127                                result.setPartyTrainingClassSessionAnswer(trainingControl.getPartyTrainingClassSessionAnswerTransfer(userVisit, partyTrainingClassSessionAnswer));
128                            }
129                        }
130                    }
131                } else {
132                    addExecutionError(ExecutionErrors.UnknownTrainingClassQuestionName.name(), trainingClassName, trainingClassSectionName,
133                            trainingClassQuestionName);
134                }
135            } else {
136                addExecutionError(ExecutionErrors.UnknownTrainingClassSectionName.name(), trainingClassName, trainingClassSectionName);
137            }
138        } else {
139            addExecutionError(ExecutionErrors.UnknownTrainingClassName.name(), trainingClassName);
140        }
141
142        return result;
143    }
144    
145}