001// --------------------------------------------------------------------------------
002// Copyright 2002-2024 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.core.server.entity.MimeType;
027import com.echothree.model.data.party.common.pk.PartyPK;
028import com.echothree.model.data.training.server.entity.TrainingClass;
029import com.echothree.model.data.training.server.entity.TrainingClassQuestion;
030import com.echothree.model.data.training.server.entity.TrainingClassSection;
031import com.echothree.model.data.user.common.pk.UserVisitPK;
032import com.echothree.util.common.message.ExecutionErrors;
033import com.echothree.util.common.validation.FieldDefinition;
034import com.echothree.util.common.validation.FieldType;
035import com.echothree.util.common.command.BaseResult;
036import com.echothree.util.server.control.BaseSimpleCommand;
037import com.echothree.util.server.control.CommandSecurityDefinition;
038import com.echothree.util.server.control.PartyTypeDefinition;
039import com.echothree.util.server.control.SecurityRoleDefinition;
040import com.echothree.util.server.persistence.Session;
041import java.util.Arrays;
042import java.util.Collections;
043import java.util.List;
044
045public class CreateTrainingClassQuestionCommand
046        extends BaseSimpleCommand<CreateTrainingClassQuestionForm> {
047    
048    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
049    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
050    
051    static {
052        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(Collections.unmodifiableList(Arrays.asList(
053                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
054                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), Collections.unmodifiableList(Arrays.asList(
055                        new SecurityRoleDefinition(SecurityRoleGroups.TrainingClassQuestion.name(), SecurityRoles.Create.name())
056                        )))
057                )));
058
059        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
060                new FieldDefinition("TrainingClassName", FieldType.ENTITY_NAME, true, null, null),
061                new FieldDefinition("TrainingClassSectionName", FieldType.ENTITY_NAME, true, null, null),
062                new FieldDefinition("TrainingClassQuestionName", FieldType.ENTITY_NAME, true, null, null),
063                new FieldDefinition("AskingRequired", FieldType.BOOLEAN, true, null, null),
064                new FieldDefinition("PassingRequired", FieldType.BOOLEAN, true, null, null),
065                new FieldDefinition("SortOrder", FieldType.SIGNED_INTEGER, true, null, null),
066                new FieldDefinition("QuestionMimeTypeName", FieldType.MIME_TYPE, false, null, null),
067                new FieldDefinition("Question", FieldType.STRING, false, null, null)
068                ));
069    }
070    
071    /** Creates a new instance of CreateTrainingClassQuestionCommand */
072    public CreateTrainingClassQuestionCommand(UserVisitPK userVisitPK, CreateTrainingClassQuestionForm form) {
073        super(userVisitPK, form, COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
074    }
075    
076    @Override
077    protected BaseResult execute() {
078        var trainingControl = Session.getModelController(TrainingControl.class);
079        String trainingClassName = form.getTrainingClassName();
080        TrainingClass trainingClass = trainingControl.getTrainingClassByName(trainingClassName);
081
082        if(trainingClass != null) {
083            String trainingClassSectionName = form.getTrainingClassSectionName();
084            TrainingClassSection trainingClassSection = trainingControl.getTrainingClassSectionByName(trainingClass, trainingClassSectionName);
085
086            if(trainingClassSection != null) {
087                String trainingClassQuestionName = form.getTrainingClassQuestionName();
088                TrainingClassQuestion trainingClassQuestion = trainingControl.getTrainingClassQuestionByName(trainingClassSection, trainingClassQuestionName);
089
090                if(trainingClassQuestion == null) {
091                    MimeTypeLogic mimeTypeLogic = MimeTypeLogic.getInstance();
092                    String question = form.getQuestion();
093                    MimeType questionMimeType = mimeTypeLogic.checkMimeType(this, form.getQuestionMimeTypeName(), question, MimeTypeUsageTypes.TEXT.name(),
094                            ExecutionErrors.MissingRequiredQuestionMimeTypeName.name(), ExecutionErrors.MissingRequiredQuestion.name(),
095                            ExecutionErrors.UnknownQuestionMimeTypeName.name(), ExecutionErrors.UnknownQuestionMimeTypeUsage.name());
096
097                    if(!hasExecutionErrors()) {
098                        PartyPK createdBy = getPartyPK();
099                        Boolean askingRequired = Boolean.valueOf(form.getAskingRequired());
100                        Boolean passingRequired = Boolean.valueOf(form.getPassingRequired());
101                        var sortOrder = Integer.valueOf(form.getSortOrder());
102
103                        trainingClassQuestion = trainingControl.createTrainingClassQuestion(trainingClassSection, trainingClassQuestionName, askingRequired,
104                                passingRequired, sortOrder, createdBy);
105
106                        if(question != null) {
107                            trainingControl.createTrainingClassQuestionTranslation(trainingClassQuestion, getPreferredLanguage(), questionMimeType,
108                                    question, createdBy);
109                        }
110                    }
111                } else {
112                    addExecutionError(ExecutionErrors.DuplicateTrainingClassQuestionName.name(), trainingClassName, trainingClassSectionName, trainingClassQuestionName);
113                }
114            } else {
115                addExecutionError(ExecutionErrors.UnknownTrainingClassSectionName.name(), trainingClassName, trainingClassSectionName);
116            }
117        } else {
118            addExecutionError(ExecutionErrors.UnknownTrainingClassName.name(), trainingClassName);
119        }
120
121        return null;
122    }
123    
124}