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.CreateTrainingClassSectionForm;
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.TrainingClassSection;
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 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(List.of(
050                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
051                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
052                        new SecurityRoleDefinition(SecurityRoleGroups.TrainingClassSection.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("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    @Inject
071    TrainingControl trainingControl;
072
073    @Inject
074    MimeTypeLogic mimeTypeLogic;
075
076    
077    /** Creates a new instance of CreateTrainingClassSectionCommand */
078    public CreateTrainingClassSectionCommand() {
079        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
080    }
081    
082    @Override
083    protected BaseResult execute() {
084        var result = TrainingResultFactory.getCreateTrainingClassSectionResult();
085        TrainingClassSection trainingClassSection = null;
086        var trainingClassName = form.getTrainingClassName();
087        var trainingClass = trainingControl.getTrainingClassByName(trainingClassName);
088
089        if(trainingClass != null) {
090            var trainingClassSectionName = form.getTrainingClassSectionName();
091
092            trainingClassSection = trainingControl.getTrainingClassSectionByName(trainingClass, trainingClassSectionName);
093
094            if(trainingClassSection == null) {
095                var overview = form.getOverview();
096                var overviewMimeType = mimeTypeLogic.checkMimeType(this, form.getOverviewMimeTypeName(), overview, MimeTypeUsageTypes.TEXT.name(),
097                        ExecutionErrors.MissingRequiredOverviewMimeTypeName.name(), ExecutionErrors.MissingRequiredOverview.name(),
098                        ExecutionErrors.UnknownOverviewMimeTypeName.name(), ExecutionErrors.UnknownOverviewMimeTypeUsage.name());
099
100                if(!hasExecutionErrors()) {
101                    var introduction = form.getIntroduction();
102                    var introductionMimeType = mimeTypeLogic.checkMimeType(this, form.getIntroductionMimeTypeName(), introduction, MimeTypeUsageTypes.TEXT.name(),
103                            ExecutionErrors.MissingRequiredIntroductionMimeTypeName.name(), ExecutionErrors.MissingRequiredIntroduction.name(),
104                            ExecutionErrors.UnknownIntroductionMimeTypeName.name(), ExecutionErrors.UnknownIntroductionMimeTypeUsage.name());
105
106                    if(!hasExecutionErrors()) {
107                        var createdBy = getPartyPK();
108                        var strPercentageToPass = form.getPercentageToPass();
109                        var percentageToPass = strPercentageToPass == null ? null : Integer.valueOf(strPercentageToPass);
110                        var strQuestionCount = form.getQuestionCount();
111                        var questionCount = strQuestionCount == null ? null : Integer.valueOf(strQuestionCount);
112                        var sortOrder = Integer.valueOf(form.getSortOrder());
113                        var description = form.getDescription();
114
115                        trainingClassSection = trainingControl.createTrainingClassSection(trainingClass, trainingClassSectionName, percentageToPass,
116                                questionCount, sortOrder, createdBy);
117
118                        if(description != null || overview != null || introduction != null) {
119                            trainingControl.createTrainingClassSectionTranslation(trainingClassSection, getPreferredLanguage(), description, overviewMimeType,
120                                    overview, introductionMimeType, introduction, createdBy);
121                        }
122                    }
123                }
124            } else {
125                addExecutionError(ExecutionErrors.DuplicateTrainingClassSectionName.name(), trainingClassName, trainingClassSectionName);
126            }
127        } else {
128            addExecutionError(ExecutionErrors.UnknownTrainingClassName.name(), trainingClassName);
129        }
130
131        if(trainingClassSection != null) {
132            result.setEntityRef(trainingClassSection.getPrimaryKey().getEntityRef());
133            result.setTrainingClassName(trainingClassSection.getLastDetail().getTrainingClass().getLastDetail().getTrainingClassName());
134            result.setTrainingClassSectionName(trainingClassSection.getLastDetail().getTrainingClassSectionName());
135        }
136
137        return result;
138    }
139    
140}