001// --------------------------------------------------------------------------------
002// Copyright 2002-2025 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.model.control.core.common.MimeTypeUsageTypes;
021import com.echothree.model.control.core.server.logic.MimeTypeLogic;
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.data.user.common.pk.UserVisitPK;
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.Arrays;
037import java.util.Collections;
038import java.util.List;
039import javax.enterprise.context.RequestScoped;
040
041@RequestScoped
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(Collections.unmodifiableList(Arrays.asList(
050                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
051                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), Collections.unmodifiableList(Arrays.asList(
052                        new SecurityRoleDefinition(SecurityRoleGroups.TrainingClassAnswer.name(), SecurityRoles.Create.name())
053                        )))
054                )));
055
056        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
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    /** Creates a new instance of CreateTrainingClassAnswerCommand */
071    public CreateTrainingClassAnswerCommand() {
072        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
073    }
074    
075    @Override
076    protected BaseResult execute() {
077        var trainingControl = Session.getModelController(TrainingControl.class);
078        var trainingClassName = form.getTrainingClassName();
079        var trainingClass = trainingControl.getTrainingClassByName(trainingClassName);
080
081        if(trainingClass != null) {
082            var trainingClassSectionName = form.getTrainingClassSectionName();
083            var trainingClassSection = trainingControl.getTrainingClassSectionByName(trainingClass, trainingClassSectionName);
084
085            if(trainingClassSection != null) {
086                var trainingClassQuestionName = form.getTrainingClassQuestionName();
087                var trainingClassQuestion = trainingControl.getTrainingClassQuestionByName(trainingClassSection, trainingClassQuestionName);
088
089                if(trainingClassQuestion != null) {
090                    var trainingClassAnswerName = form.getTrainingClassAnswerName();
091                    var trainingClassAnswer = trainingControl.getTrainingClassAnswerByName(trainingClassQuestion, trainingClassAnswerName);
092
093                    if(trainingClassAnswer == null) {
094                        var mimeTypeLogic = MimeTypeLogic.getInstance();
095                        var answer = form.getAnswer();
096                        var answerMimeType = mimeTypeLogic.checkMimeType(this, form.getAnswerMimeTypeName(), answer, MimeTypeUsageTypes.TEXT.name(),
097                                ExecutionErrors.MissingRequiredAnswerMimeTypeName.name(), ExecutionErrors.MissingRequiredAnswer.name(),
098                                ExecutionErrors.UnknownAnswerMimeTypeName.name(), ExecutionErrors.UnknownAnswerMimeTypeUsage.name());
099
100                        if(!hasExecutionErrors()) {
101                            var selected = form.getSelected();
102                            var selectedMimeType = mimeTypeLogic.checkMimeType(this, form.getSelectedMimeTypeName(), selected, MimeTypeUsageTypes.TEXT.name(),
103                                    ExecutionErrors.MissingRequiredSelectedMimeTypeName.name(), ExecutionErrors.MissingRequiredSelected.name(),
104                                    ExecutionErrors.UnknownSelectedMimeTypeName.name(), ExecutionErrors.UnknownSelectedMimeTypeUsage.name());
105
106                            if(!hasExecutionErrors()) {
107                                if(answer == null && selected != null) {
108                                    addExecutionError(ExecutionErrors.MissingRequiredAnswerMimeTypeName.name());
109                                    addExecutionError(ExecutionErrors.MissingRequiredAnswer.name());
110                                } else {
111                                    var createdBy = getPartyPK();
112                                    var isCorrect = Boolean.valueOf(form.getIsCorrect());
113                                    var sortOrder = Integer.valueOf(form.getSortOrder());
114
115                                    trainingClassAnswer = trainingControl.createTrainingClassAnswer(trainingClassQuestion, trainingClassAnswerName, isCorrect,
116                                            sortOrder, createdBy);
117
118                                    if(answer != null || selected != null) {
119                                        trainingControl.createTrainingClassAnswerTranslation(trainingClassAnswer, getPreferredLanguage(), answerMimeType,
120                                                answer, selectedMimeType, selected, createdBy);
121                                    }
122                                }
123                            }
124                        }
125                    } else {
126                        addExecutionError(ExecutionErrors.DuplicateTrainingClassAnswerName.name(), trainingClassName, trainingClassSectionName,
127                                trainingClassQuestionName, trainingClassAnswerName);
128                    }
129                } else {
130                    addExecutionError(ExecutionErrors.UnknownTrainingClassQuestionName.name(), trainingClassName, trainingClassSectionName,
131                            trainingClassQuestionName);
132                }
133            } else {
134                addExecutionError(ExecutionErrors.UnknownTrainingClassSectionName.name(), trainingClassName, trainingClassSectionName);
135            }
136        } else {
137            addExecutionError(ExecutionErrors.UnknownTrainingClassName.name(), trainingClassName);
138        }
139
140        return null;
141    }
142    
143}