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.CreateTrainingClassQuestionForm;
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.TrainingClassQuestion;
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 CreateTrainingClassQuestionCommand
043        extends BaseSimpleCommand<CreateTrainingClassQuestionForm> {
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.TrainingClassQuestion.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("AskingRequired", FieldType.BOOLEAN, true, null, null),
061                new FieldDefinition("PassingRequired", FieldType.BOOLEAN, true, null, null),
062                new FieldDefinition("SortOrder", FieldType.SIGNED_INTEGER, true, null, null),
063                new FieldDefinition("QuestionMimeTypeName", FieldType.MIME_TYPE, false, null, null),
064                new FieldDefinition("Question", FieldType.STRING, false, null, null)
065        );
066    }
067
068    @Inject
069    TrainingControl trainingControl;
070
071    @Inject
072    MimeTypeLogic mimeTypeLogic;
073
074    
075    /** Creates a new instance of CreateTrainingClassQuestionCommand */
076    public CreateTrainingClassQuestionCommand() {
077        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
078    }
079    
080    @Override
081    protected BaseResult execute() {
082        var result = TrainingResultFactory.getCreateTrainingClassQuestionResult();
083        TrainingClassQuestion trainingClassQuestion = null;
084        var trainingClassName = form.getTrainingClassName();
085        var trainingClass = trainingControl.getTrainingClassByName(trainingClassName);
086
087        if(trainingClass != null) {
088            var trainingClassSectionName = form.getTrainingClassSectionName();
089            var trainingClassSection = trainingControl.getTrainingClassSectionByName(trainingClass, trainingClassSectionName);
090
091            if(trainingClassSection != null) {
092                var trainingClassQuestionName = form.getTrainingClassQuestionName();
093
094                trainingClassQuestion = trainingControl.getTrainingClassQuestionByName(trainingClassSection, trainingClassQuestionName);
095
096                if(trainingClassQuestion == null) {
097                    var question = form.getQuestion();
098                    var questionMimeType = mimeTypeLogic.checkMimeType(this, form.getQuestionMimeTypeName(), question, MimeTypeUsageTypes.TEXT.name(),
099                            ExecutionErrors.MissingRequiredQuestionMimeTypeName.name(), ExecutionErrors.MissingRequiredQuestion.name(),
100                            ExecutionErrors.UnknownQuestionMimeTypeName.name(), ExecutionErrors.UnknownQuestionMimeTypeUsage.name());
101
102                    if(!hasExecutionErrors()) {
103                        var createdBy = getPartyPK();
104                        var askingRequired = Boolean.valueOf(form.getAskingRequired());
105                        var passingRequired = Boolean.valueOf(form.getPassingRequired());
106                        var sortOrder = Integer.valueOf(form.getSortOrder());
107
108                        trainingClassQuestion = trainingControl.createTrainingClassQuestion(trainingClassSection, trainingClassQuestionName, askingRequired,
109                                passingRequired, sortOrder, createdBy);
110
111                        if(question != null) {
112                            trainingControl.createTrainingClassQuestionTranslation(trainingClassQuestion, getPreferredLanguage(), questionMimeType,
113                                    question, createdBy);
114                        }
115                    }
116                } else {
117                    addExecutionError(ExecutionErrors.DuplicateTrainingClassQuestionName.name(), trainingClassName, trainingClassSectionName, trainingClassQuestionName);
118                }
119            } else {
120                addExecutionError(ExecutionErrors.UnknownTrainingClassSectionName.name(), trainingClassName, trainingClassSectionName);
121            }
122        } else {
123            addExecutionError(ExecutionErrors.UnknownTrainingClassName.name(), trainingClassName);
124        }
125
126        if(trainingClassQuestion != null) {
127            result.setEntityRef(trainingClassQuestion.getPrimaryKey().getEntityRef());
128            result.setTrainingClassName(trainingClassQuestion.getLastDetail().getTrainingClassSection().getLastDetail().getTrainingClass().getLastDetail().getTrainingClassName());
129            result.setTrainingClassSectionName(trainingClassQuestion.getLastDetail().getTrainingClassSection().getLastDetail().getTrainingClassSectionName());
130            result.setTrainingClassQuestionName(trainingClassQuestion.getLastDetail().getTrainingClassQuestionName());
131        }
132
133        return result;
134    }
135    
136}