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.CreateTrainingClassSectionForm;
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 CreateTrainingClassSectionCommand
043        extends BaseSimpleCommand<CreateTrainingClassSectionForm> {
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.TrainingClassSection.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("PercentageToPass", FieldType.FRACTIONAL_PERCENT, false, null, null),
060                new FieldDefinition("QuestionCount", FieldType.UNSIGNED_INTEGER, false, null, null),
061                new FieldDefinition("SortOrder", FieldType.SIGNED_INTEGER, true, null, null),
062                new FieldDefinition("Description", FieldType.STRING, false, 1L, 132L),
063                new FieldDefinition("OverviewMimeTypeName", FieldType.MIME_TYPE, false, null, null),
064                new FieldDefinition("Overview", FieldType.STRING, false, null, null),
065                new FieldDefinition("IntroductionMimeTypeName", FieldType.MIME_TYPE, false, null, null),
066                new FieldDefinition("Introduction", FieldType.STRING, false, null, null)
067                ));
068    }
069    
070    /** Creates a new instance of CreateTrainingClassSectionCommand */
071    public CreateTrainingClassSectionCommand() {
072        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
073    }
074    
075    @Override
076    protected BaseResult execute() {
077        var trainingControl = Session.getModelController(TrainingControl.class);
078        var trainingClassName = form.getTrainingClassName();
079        var trainingClass = trainingControl.getTrainingClassByName(trainingClassName);
080
081        if(trainingClass != null) {
082            var trainingClassSectionName = form.getTrainingClassSectionName();
083            var trainingClassSection = trainingControl.getTrainingClassSectionByName(trainingClass, trainingClassSectionName);
084
085            if(trainingClassSection == null) {
086                var mimeTypeLogic = MimeTypeLogic.getInstance();
087                var overview = form.getOverview();
088                var overviewMimeType = mimeTypeLogic.checkMimeType(this, form.getOverviewMimeTypeName(), overview, MimeTypeUsageTypes.TEXT.name(),
089                        ExecutionErrors.MissingRequiredOverviewMimeTypeName.name(), ExecutionErrors.MissingRequiredOverview.name(),
090                        ExecutionErrors.UnknownOverviewMimeTypeName.name(), ExecutionErrors.UnknownOverviewMimeTypeUsage.name());
091
092                if(!hasExecutionErrors()) {
093                    var introduction = form.getIntroduction();
094                    var introductionMimeType = mimeTypeLogic.checkMimeType(this, form.getIntroductionMimeTypeName(), introduction, MimeTypeUsageTypes.TEXT.name(),
095                            ExecutionErrors.MissingRequiredIntroductionMimeTypeName.name(), ExecutionErrors.MissingRequiredIntroduction.name(),
096                            ExecutionErrors.UnknownIntroductionMimeTypeName.name(), ExecutionErrors.UnknownIntroductionMimeTypeUsage.name());
097
098                    if(!hasExecutionErrors()) {
099                        var createdBy = getPartyPK();
100                        var strPercentageToPass = form.getPercentageToPass();
101                        var percentageToPass = strPercentageToPass == null ? null : Integer.valueOf(strPercentageToPass);
102                        var strQuestionCount = form.getQuestionCount();
103                        var questionCount = strQuestionCount == null ? null : Integer.valueOf(strQuestionCount);
104                        var sortOrder = Integer.valueOf(form.getSortOrder());
105                        var description = form.getDescription();
106
107                        trainingClassSection = trainingControl.createTrainingClassSection(trainingClass, trainingClassSectionName, percentageToPass,
108                                questionCount, sortOrder, createdBy);
109
110                        if(description != null || overview != null || introduction != null) {
111                            trainingControl.createTrainingClassSectionTranslation(trainingClassSection, getPreferredLanguage(), description, overviewMimeType,
112                                    overview, introductionMimeType, introduction, createdBy);
113                        }
114                    }
115                }
116            } else {
117                addExecutionError(ExecutionErrors.DuplicateTrainingClassSectionName.name(), trainingClassName, trainingClassSectionName);
118            }
119        } else {
120            addExecutionError(ExecutionErrors.UnknownTrainingClassName.name(), trainingClassName);
121        }
122
123        return null;
124    }
125    
126}