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