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.CreateTrainingClassAnswerForm;
020import com.echothree.control.user.training.common.result.TrainingResultFactory;
021import com.echothree.model.control.core.common.MimeTypeUsageTypes;
022import com.echothree.model.control.core.server.logic.MimeTypeLogic;
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.TrainingClassAnswer;
028import com.echothree.model.data.user.common.pk.UserVisitPK;
029import com.echothree.util.common.command.BaseResult;
030import com.echothree.util.common.message.ExecutionErrors;
031import com.echothree.util.common.validation.FieldDefinition;
032import com.echothree.util.common.validation.FieldType;
033import com.echothree.util.server.control.BaseSimpleCommand;
034import com.echothree.util.server.control.CommandSecurityDefinition;
035import com.echothree.util.server.control.PartyTypeDefinition;
036import com.echothree.util.server.control.SecurityRoleDefinition;
037import java.util.List;
038import javax.enterprise.context.Dependent;
039import javax.inject.Inject;
040
041@Dependent
042public class CreateTrainingClassAnswerCommand
043        extends BaseSimpleCommand<CreateTrainingClassAnswerForm> {
044    
045    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
046    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
047    
048    static {
049        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(List.of(
050                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
051                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
052                        new SecurityRoleDefinition(SecurityRoleGroups.TrainingClassAnswer.name(), SecurityRoles.Create.name())
053                ))
054        ));
055
056        FORM_FIELD_DEFINITIONS = List.of(
057                new FieldDefinition("TrainingClassName", FieldType.ENTITY_NAME, true, null, null),
058                new FieldDefinition("TrainingClassSectionName", FieldType.ENTITY_NAME, true, null, null),
059                new FieldDefinition("TrainingClassQuestionName", FieldType.ENTITY_NAME, true, null, null),
060                new FieldDefinition("TrainingClassAnswerName", FieldType.ENTITY_NAME, true, null, null),
061                new FieldDefinition("IsCorrect", FieldType.BOOLEAN, true, null, null),
062                new FieldDefinition("SortOrder", FieldType.SIGNED_INTEGER, true, null, null),
063                new FieldDefinition("AnswerMimeTypeName", FieldType.MIME_TYPE, false, null, null),
064                new FieldDefinition("Answer", FieldType.STRING, false, null, null),
065                new FieldDefinition("SelectedMimeTypeName", FieldType.MIME_TYPE, false, null, null),
066                new FieldDefinition("Selected", FieldType.STRING, false, null, null)
067        );
068    }
069
070    @Inject
071    TrainingControl trainingControl;
072
073    @Inject
074    MimeTypeLogic mimeTypeLogic;
075
076    
077    /** Creates a new instance of CreateTrainingClassAnswerCommand */
078    public CreateTrainingClassAnswerCommand() {
079        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
080    }
081    
082    @Override
083    protected BaseResult execute() {
084        var result = TrainingResultFactory.getCreateTrainingClassAnswerResult();
085        TrainingClassAnswer trainingClassAnswer = null;
086        var trainingClassName = form.getTrainingClassName();
087        var trainingClass = trainingControl.getTrainingClassByName(trainingClassName);
088
089        if(trainingClass != null) {
090            var trainingClassSectionName = form.getTrainingClassSectionName();
091            var trainingClassSection = trainingControl.getTrainingClassSectionByName(trainingClass, trainingClassSectionName);
092
093            if(trainingClassSection != null) {
094                var trainingClassQuestionName = form.getTrainingClassQuestionName();
095                var trainingClassQuestion = trainingControl.getTrainingClassQuestionByName(trainingClassSection, trainingClassQuestionName);
096
097                if(trainingClassQuestion != null) {
098                    var trainingClassAnswerName = form.getTrainingClassAnswerName();
099
100                    trainingClassAnswer = trainingControl.getTrainingClassAnswerByName(trainingClassQuestion, trainingClassAnswerName);
101
102                    if(trainingClassAnswer == null) {
103                        var answer = form.getAnswer();
104                        var answerMimeType = mimeTypeLogic.checkMimeType(this, form.getAnswerMimeTypeName(), answer, MimeTypeUsageTypes.TEXT.name(),
105                                ExecutionErrors.MissingRequiredAnswerMimeTypeName.name(), ExecutionErrors.MissingRequiredAnswer.name(),
106                                ExecutionErrors.UnknownAnswerMimeTypeName.name(), ExecutionErrors.UnknownAnswerMimeTypeUsage.name());
107
108                        if(!hasExecutionErrors()) {
109                            var selected = form.getSelected();
110                            var selectedMimeType = mimeTypeLogic.checkMimeType(this, form.getSelectedMimeTypeName(), selected, MimeTypeUsageTypes.TEXT.name(),
111                                    ExecutionErrors.MissingRequiredSelectedMimeTypeName.name(), ExecutionErrors.MissingRequiredSelected.name(),
112                                    ExecutionErrors.UnknownSelectedMimeTypeName.name(), ExecutionErrors.UnknownSelectedMimeTypeUsage.name());
113
114                            if(!hasExecutionErrors()) {
115                                if(answer == null && selected != null) {
116                                    addExecutionError(ExecutionErrors.MissingRequiredAnswerMimeTypeName.name());
117                                    addExecutionError(ExecutionErrors.MissingRequiredAnswer.name());
118                                } else {
119                                    var createdBy = getPartyPK();
120                                    var isCorrect = Boolean.valueOf(form.getIsCorrect());
121                                    var sortOrder = Integer.valueOf(form.getSortOrder());
122
123                                    trainingClassAnswer = trainingControl.createTrainingClassAnswer(trainingClassQuestion, trainingClassAnswerName, isCorrect,
124                                            sortOrder, createdBy);
125
126                                    if(answer != null || selected != null) {
127                                        trainingControl.createTrainingClassAnswerTranslation(trainingClassAnswer, getPreferredLanguage(), answerMimeType,
128                                                answer, selectedMimeType, selected, createdBy);
129                                    }
130                                }
131                            }
132                        }
133                    } else {
134                        addExecutionError(ExecutionErrors.DuplicateTrainingClassAnswerName.name(), trainingClassName, trainingClassSectionName,
135                                trainingClassQuestionName, trainingClassAnswerName);
136                    }
137                } else {
138                    addExecutionError(ExecutionErrors.UnknownTrainingClassQuestionName.name(), trainingClassName, trainingClassSectionName,
139                            trainingClassQuestionName);
140                }
141            } else {
142                addExecutionError(ExecutionErrors.UnknownTrainingClassSectionName.name(), trainingClassName, trainingClassSectionName);
143            }
144        } else {
145            addExecutionError(ExecutionErrors.UnknownTrainingClassName.name(), trainingClassName);
146        }
147
148        if(trainingClassAnswer != null) {
149            result.setEntityRef(trainingClassAnswer.getPrimaryKey().getEntityRef());
150            result.setTrainingClassName(trainingClassAnswer.getLastDetail().getTrainingClassQuestion().getLastDetail().getTrainingClassSection().getLastDetail().getTrainingClass().getLastDetail().getTrainingClassName());
151            result.setTrainingClassSectionName(trainingClassAnswer.getLastDetail().getTrainingClassQuestion().getLastDetail().getTrainingClassSection().getLastDetail().getTrainingClassSectionName());
152            result.setTrainingClassQuestionName(trainingClassAnswer.getLastDetail().getTrainingClassQuestion().getLastDetail().getTrainingClassQuestionName());
153            result.setTrainingClassAnswerName(trainingClassAnswer.getLastDetail().getTrainingClassAnswerName());
154        }
155
156        return result;
157    }
158    
159}