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.CreateTrainingClassQuestionForm;
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 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(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.TrainingClassQuestion.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("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    /** Creates a new instance of CreateTrainingClassQuestionCommand */
069    public CreateTrainingClassQuestionCommand() {
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 mimeTypeLogic = MimeTypeLogic.getInstance();
089                    var question = form.getQuestion();
090                    var questionMimeType = mimeTypeLogic.checkMimeType(this, form.getQuestionMimeTypeName(), question, MimeTypeUsageTypes.TEXT.name(),
091                            ExecutionErrors.MissingRequiredQuestionMimeTypeName.name(), ExecutionErrors.MissingRequiredQuestion.name(),
092                            ExecutionErrors.UnknownQuestionMimeTypeName.name(), ExecutionErrors.UnknownQuestionMimeTypeUsage.name());
093
094                    if(!hasExecutionErrors()) {
095                        var createdBy = getPartyPK();
096                        var askingRequired = Boolean.valueOf(form.getAskingRequired());
097                        var passingRequired = Boolean.valueOf(form.getPassingRequired());
098                        var sortOrder = Integer.valueOf(form.getSortOrder());
099
100                        trainingClassQuestion = trainingControl.createTrainingClassQuestion(trainingClassSection, trainingClassQuestionName, askingRequired,
101                                passingRequired, sortOrder, createdBy);
102
103                        if(question != null) {
104                            trainingControl.createTrainingClassQuestionTranslation(trainingClassQuestion, getPreferredLanguage(), questionMimeType,
105                                    question, createdBy);
106                        }
107                    }
108                } else {
109                    addExecutionError(ExecutionErrors.DuplicateTrainingClassQuestionName.name(), trainingClassName, trainingClassSectionName, trainingClassQuestionName);
110                }
111            } else {
112                addExecutionError(ExecutionErrors.UnknownTrainingClassSectionName.name(), trainingClassName, trainingClassSectionName);
113            }
114        } else {
115            addExecutionError(ExecutionErrors.UnknownTrainingClassName.name(), trainingClassName);
116        }
117
118        return null;
119    }
120    
121}