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.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.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.TrainingClassAnswer;
030import com.echothree.model.data.training.server.entity.TrainingClassQuestion;
031import com.echothree.model.data.training.server.entity.TrainingClassSection;
032import com.echothree.model.data.user.common.pk.UserVisitPK;
033import com.echothree.util.common.message.ExecutionErrors;
034import com.echothree.util.common.validation.FieldDefinition;
035import com.echothree.util.common.validation.FieldType;
036import com.echothree.util.common.command.BaseResult;
037import com.echothree.util.server.control.BaseSimpleCommand;
038import com.echothree.util.server.control.CommandSecurityDefinition;
039import com.echothree.util.server.control.PartyTypeDefinition;
040import com.echothree.util.server.control.SecurityRoleDefinition;
041import com.echothree.util.server.persistence.Session;
042import java.util.Arrays;
043import java.util.Collections;
044import java.util.List;
045
046public class CreateTrainingClassAnswerCommand
047        extends BaseSimpleCommand<CreateTrainingClassAnswerForm> {
048    
049    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
050    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
051    
052    static {
053        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(Collections.unmodifiableList(Arrays.asList(
054                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
055                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), Collections.unmodifiableList(Arrays.asList(
056                        new SecurityRoleDefinition(SecurityRoleGroups.TrainingClassAnswer.name(), SecurityRoles.Create.name())
057                        )))
058                )));
059
060        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
061                new FieldDefinition("TrainingClassName", FieldType.ENTITY_NAME, true, null, null),
062                new FieldDefinition("TrainingClassSectionName", FieldType.ENTITY_NAME, true, null, null),
063                new FieldDefinition("TrainingClassQuestionName", FieldType.ENTITY_NAME, true, null, null),
064                new FieldDefinition("TrainingClassAnswerName", FieldType.ENTITY_NAME, true, null, null),
065                new FieldDefinition("IsCorrect", FieldType.BOOLEAN, true, null, null),
066                new FieldDefinition("SortOrder", FieldType.SIGNED_INTEGER, true, null, null),
067                new FieldDefinition("AnswerMimeTypeName", FieldType.MIME_TYPE, false, null, null),
068                new FieldDefinition("Answer", FieldType.STRING, false, null, null),
069                new FieldDefinition("SelectedMimeTypeName", FieldType.MIME_TYPE, false, null, null),
070                new FieldDefinition("Selected", FieldType.STRING, false, null, null)
071                ));
072    }
073    
074    /** Creates a new instance of CreateTrainingClassAnswerCommand */
075    public CreateTrainingClassAnswerCommand(UserVisitPK userVisitPK, CreateTrainingClassAnswerForm form) {
076        super(userVisitPK, form, COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
077    }
078    
079    @Override
080    protected BaseResult execute() {
081        var trainingControl = Session.getModelController(TrainingControl.class);
082        String trainingClassName = form.getTrainingClassName();
083        TrainingClass trainingClass = trainingControl.getTrainingClassByName(trainingClassName);
084
085        if(trainingClass != null) {
086            String trainingClassSectionName = form.getTrainingClassSectionName();
087            TrainingClassSection trainingClassSection = trainingControl.getTrainingClassSectionByName(trainingClass, trainingClassSectionName);
088
089            if(trainingClassSection != null) {
090                String trainingClassQuestionName = form.getTrainingClassQuestionName();
091                TrainingClassQuestion trainingClassQuestion = trainingControl.getTrainingClassQuestionByName(trainingClassSection, trainingClassQuestionName);
092
093                if(trainingClassQuestion != null) {
094                    String trainingClassAnswerName = form.getTrainingClassAnswerName();
095                    TrainingClassAnswer trainingClassAnswer = trainingControl.getTrainingClassAnswerByName(trainingClassQuestion, trainingClassAnswerName);
096
097                    if(trainingClassAnswer == null) {
098                        MimeTypeLogic mimeTypeLogic = MimeTypeLogic.getInstance();
099                        String answer = form.getAnswer();
100                        MimeType answerMimeType = mimeTypeLogic.checkMimeType(this, form.getAnswerMimeTypeName(), answer, MimeTypeUsageTypes.TEXT.name(),
101                                ExecutionErrors.MissingRequiredAnswerMimeTypeName.name(), ExecutionErrors.MissingRequiredAnswer.name(),
102                                ExecutionErrors.UnknownAnswerMimeTypeName.name(), ExecutionErrors.UnknownAnswerMimeTypeUsage.name());
103
104                        if(!hasExecutionErrors()) {
105                            String selected = form.getSelected();
106                            MimeType selectedMimeType = mimeTypeLogic.checkMimeType(this, form.getSelectedMimeTypeName(), selected, MimeTypeUsageTypes.TEXT.name(),
107                                    ExecutionErrors.MissingRequiredSelectedMimeTypeName.name(), ExecutionErrors.MissingRequiredSelected.name(),
108                                    ExecutionErrors.UnknownSelectedMimeTypeName.name(), ExecutionErrors.UnknownSelectedMimeTypeUsage.name());
109
110                            if(!hasExecutionErrors()) {
111                                if(answer == null && selected != null) {
112                                    addExecutionError(ExecutionErrors.MissingRequiredAnswerMimeTypeName.name());
113                                    addExecutionError(ExecutionErrors.MissingRequiredAnswer.name());
114                                } else {
115                                    PartyPK createdBy = getPartyPK();
116                                    Boolean isCorrect = Boolean.valueOf(form.getIsCorrect());
117                                    var sortOrder = Integer.valueOf(form.getSortOrder());
118
119                                    trainingClassAnswer = trainingControl.createTrainingClassAnswer(trainingClassQuestion, trainingClassAnswerName, isCorrect,
120                                            sortOrder, createdBy);
121
122                                    if(answer != null || selected != null) {
123                                        trainingControl.createTrainingClassAnswerTranslation(trainingClassAnswer, getPreferredLanguage(), answerMimeType,
124                                                answer, selectedMimeType, selected, createdBy);
125                                    }
126                                }
127                            }
128                        }
129                    } else {
130                        addExecutionError(ExecutionErrors.DuplicateTrainingClassAnswerName.name(), trainingClassName, trainingClassSectionName,
131                                trainingClassQuestionName, trainingClassAnswerName);
132                    }
133                } else {
134                    addExecutionError(ExecutionErrors.UnknownTrainingClassQuestionName.name(), trainingClassName, trainingClassSectionName,
135                            trainingClassQuestionName);
136                }
137            } else {
138                addExecutionError(ExecutionErrors.UnknownTrainingClassSectionName.name(), trainingClassName, trainingClassSectionName);
139            }
140        } else {
141            addExecutionError(ExecutionErrors.UnknownTrainingClassName.name(), trainingClassName);
142        }
143
144        return null;
145    }
146    
147}