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.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.List;
037import javax.enterprise.context.Dependent;
038
039@Dependent
040public class CreateTrainingClassAnswerCommand
041        extends BaseSimpleCommand<CreateTrainingClassAnswerForm> {
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.TrainingClassAnswer.name(), SecurityRoles.Create.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("TrainingClassAnswerName", FieldType.ENTITY_NAME, true, null, null),
059                new FieldDefinition("IsCorrect", FieldType.BOOLEAN, true, null, null),
060                new FieldDefinition("SortOrder", FieldType.SIGNED_INTEGER, true, null, null),
061                new FieldDefinition("AnswerMimeTypeName", FieldType.MIME_TYPE, false, null, null),
062                new FieldDefinition("Answer", FieldType.STRING, false, null, null),
063                new FieldDefinition("SelectedMimeTypeName", FieldType.MIME_TYPE, false, null, null),
064                new FieldDefinition("Selected", FieldType.STRING, false, null, null)
065                );
066    }
067    
068    /** Creates a new instance of CreateTrainingClassAnswerCommand */
069    public CreateTrainingClassAnswerCommand() {
070        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
071    }
072    
073    @Override
074    protected BaseResult execute() {
075        var trainingControl = Session.getModelController(TrainingControl.class);
076        var trainingClassName = form.getTrainingClassName();
077        var trainingClass = trainingControl.getTrainingClassByName(trainingClassName);
078
079        if(trainingClass != null) {
080            var trainingClassSectionName = form.getTrainingClassSectionName();
081            var trainingClassSection = trainingControl.getTrainingClassSectionByName(trainingClass, trainingClassSectionName);
082
083            if(trainingClassSection != null) {
084                var trainingClassQuestionName = form.getTrainingClassQuestionName();
085                var trainingClassQuestion = trainingControl.getTrainingClassQuestionByName(trainingClassSection, trainingClassQuestionName);
086
087                if(trainingClassQuestion != null) {
088                    var trainingClassAnswerName = form.getTrainingClassAnswerName();
089                    var trainingClassAnswer = trainingControl.getTrainingClassAnswerByName(trainingClassQuestion, trainingClassAnswerName);
090
091                    if(trainingClassAnswer == null) {
092                        var mimeTypeLogic = MimeTypeLogic.getInstance();
093                        var answer = form.getAnswer();
094                        var answerMimeType = mimeTypeLogic.checkMimeType(this, form.getAnswerMimeTypeName(), answer, MimeTypeUsageTypes.TEXT.name(),
095                                ExecutionErrors.MissingRequiredAnswerMimeTypeName.name(), ExecutionErrors.MissingRequiredAnswer.name(),
096                                ExecutionErrors.UnknownAnswerMimeTypeName.name(), ExecutionErrors.UnknownAnswerMimeTypeUsage.name());
097
098                        if(!hasExecutionErrors()) {
099                            var selected = form.getSelected();
100                            var selectedMimeType = mimeTypeLogic.checkMimeType(this, form.getSelectedMimeTypeName(), selected, MimeTypeUsageTypes.TEXT.name(),
101                                    ExecutionErrors.MissingRequiredSelectedMimeTypeName.name(), ExecutionErrors.MissingRequiredSelected.name(),
102                                    ExecutionErrors.UnknownSelectedMimeTypeName.name(), ExecutionErrors.UnknownSelectedMimeTypeUsage.name());
103
104                            if(!hasExecutionErrors()) {
105                                if(answer == null && selected != null) {
106                                    addExecutionError(ExecutionErrors.MissingRequiredAnswerMimeTypeName.name());
107                                    addExecutionError(ExecutionErrors.MissingRequiredAnswer.name());
108                                } else {
109                                    var createdBy = getPartyPK();
110                                    var isCorrect = Boolean.valueOf(form.getIsCorrect());
111                                    var sortOrder = Integer.valueOf(form.getSortOrder());
112
113                                    trainingClassAnswer = trainingControl.createTrainingClassAnswer(trainingClassQuestion, trainingClassAnswerName, isCorrect,
114                                            sortOrder, createdBy);
115
116                                    if(answer != null || selected != null) {
117                                        trainingControl.createTrainingClassAnswerTranslation(trainingClassAnswer, getPreferredLanguage(), answerMimeType,
118                                                answer, selectedMimeType, selected, createdBy);
119                                    }
120                                }
121                            }
122                        }
123                    } else {
124                        addExecutionError(ExecutionErrors.DuplicateTrainingClassAnswerName.name(), trainingClassName, trainingClassSectionName,
125                                trainingClassQuestionName, trainingClassAnswerName);
126                    }
127                } else {
128                    addExecutionError(ExecutionErrors.UnknownTrainingClassQuestionName.name(), trainingClassName, trainingClassSectionName,
129                            trainingClassQuestionName);
130                }
131            } else {
132                addExecutionError(ExecutionErrors.UnknownTrainingClassSectionName.name(), trainingClassName, trainingClassSectionName);
133            }
134        } else {
135            addExecutionError(ExecutionErrors.UnknownTrainingClassName.name(), trainingClassName);
136        }
137
138        return null;
139    }
140    
141}