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 com.echothree.util.server.persistence.Session;
036import java.util.List;
037import javax.enterprise.context.Dependent;
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    /** Creates a new instance of GetTrainingClassQuestionCommand */
063    public GetTrainingClassQuestionCommand() {
064        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, true);
065    }
066    
067    @Override
068    protected BaseResult execute() {
069        var trainingControl = Session.getModelController(TrainingControl.class);
070        var result = TrainingResultFactory.getGetTrainingClassQuestionResult();
071        var trainingClassName = form.getTrainingClassName();
072        var trainingClass = trainingControl.getTrainingClassByName(trainingClassName);
073
074        if(trainingClass != null) {
075            var trainingClassSectionName = form.getTrainingClassSectionName();
076            var trainingClassSection = trainingControl.getTrainingClassSectionByName(trainingClass, trainingClassSectionName);
077
078            if(trainingClassSection != null) {
079                var trainingClassQuestionName = form.getTrainingClassQuestionName();
080                var trainingClassQuestion = trainingControl.getTrainingClassQuestionByName(trainingClassSection, trainingClassQuestionName);
081
082                if(trainingClassQuestion != null) {
083                    var partyTrainingClassName = form.getPartyTrainingClassName();
084                    var partyTrainingClassSessionStatus = partyTrainingClassName == null ? null
085                            : PartyTrainingClassSessionLogic.getInstance().getLatestPartyTrainingClassSessionStatusForUpdate(this, partyTrainingClassName);
086                    
087                    if(!hasExecutionErrors()) {
088                        var partyTrainingClassSession = partyTrainingClassSessionStatus == null ? null
089                                : partyTrainingClassSessionStatus.getPartyTrainingClassSession();
090                        
091                        // Verify that the TrainingClass from above is same as the one being used by the PartyTrainingClassSession.
092                        if(partyTrainingClassSession != null) {
093                            if(!trainingClass.equals(partyTrainingClassSession.getLastDetail().getPartyTrainingClass().getLastDetail().getTrainingClass())) {
094                                addExecutionError(ExecutionErrors.InvalidPartyTrainingClass.name(), partyTrainingClassName);
095                            }
096                        }
097                        
098                        if(!hasExecutionErrors()) {
099                            var userVisit = getUserVisit();
100                            var partyPK = getPartyPK();
101
102                            result.setTrainingClassQuestion(trainingControl.getTrainingClassQuestionTransfer(userVisit, trainingClassQuestion));
103
104                            sendEvent(trainingClassQuestion.getPrimaryKey(), EventTypes.READ, null, null, partyPK);
105
106                            if(partyTrainingClassSessionStatus != null) {
107                                var partyTrainingClassSessionQuestion = trainingControl.getPartyTrainingClassSessionQuestion(partyTrainingClassSession, trainingClassQuestion);
108
109                                // If there isn't an existing PartyTrainingClassSessionQuestion, then we'll create one to attach the Answer to.
110                                if(partyTrainingClassSessionQuestion == null) {
111                                    partyTrainingClassSessionQuestion = trainingControl.createPartyTrainingClassSessionQuestion(partyTrainingClassSessionStatus.getPartyTrainingClassSession(),
112                                            trainingClassQuestion, null, partyPK);
113                                }
114
115                                var partyTrainingClassSessionAnswer = trainingControl.createPartyTrainingClassSessionAnswer(partyTrainingClassSessionQuestion,
116                                        null, session.getStartTime(), null, partyPK);
117
118                                PartyTrainingClassSessionLogic.getInstance().updatePartyTrainingClassSessionStatus(session, partyTrainingClassSessionStatus,
119                                        null, null, partyTrainingClassSessionQuestion);
120                                
121                                result.setPartyTrainingClassSessionAnswer(trainingControl.getPartyTrainingClassSessionAnswerTransfer(userVisit, partyTrainingClassSessionAnswer));
122                            }
123                        }
124                    }
125                } else {
126                    addExecutionError(ExecutionErrors.UnknownTrainingClassQuestionName.name(), trainingClassName, trainingClassSectionName,
127                            trainingClassQuestionName);
128                }
129            } else {
130                addExecutionError(ExecutionErrors.UnknownTrainingClassSectionName.name(), trainingClassName, trainingClassSectionName);
131            }
132        } else {
133            addExecutionError(ExecutionErrors.UnknownTrainingClassName.name(), trainingClassName);
134        }
135
136        return result;
137    }
138    
139}