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.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.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.TrainingClassSection;
030import com.echothree.model.data.user.common.pk.UserVisitPK;
031import com.echothree.util.common.message.ExecutionErrors;
032import com.echothree.util.common.validation.FieldDefinition;
033import com.echothree.util.common.validation.FieldType;
034import com.echothree.util.common.command.BaseResult;
035import com.echothree.util.server.control.BaseSimpleCommand;
036import com.echothree.util.server.control.CommandSecurityDefinition;
037import com.echothree.util.server.control.PartyTypeDefinition;
038import com.echothree.util.server.control.SecurityRoleDefinition;
039import com.echothree.util.server.persistence.Session;
040import java.util.Arrays;
041import java.util.Collections;
042import java.util.List;
043
044public class CreateTrainingClassSectionCommand
045        extends BaseSimpleCommand<CreateTrainingClassSectionForm> {
046    
047    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
048    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
049    
050    static {
051        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(Collections.unmodifiableList(Arrays.asList(
052                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
053                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), Collections.unmodifiableList(Arrays.asList(
054                        new SecurityRoleDefinition(SecurityRoleGroups.TrainingClassSection.name(), SecurityRoles.Create.name())
055                        )))
056                )));
057
058        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
059                new FieldDefinition("TrainingClassName", FieldType.ENTITY_NAME, true, null, null),
060                new FieldDefinition("TrainingClassSectionName", FieldType.ENTITY_NAME, true, null, null),
061                new FieldDefinition("PercentageToPass", FieldType.FRACTIONAL_PERCENT, false, null, null),
062                new FieldDefinition("QuestionCount", FieldType.UNSIGNED_INTEGER, false, null, null),
063                new FieldDefinition("SortOrder", FieldType.SIGNED_INTEGER, true, null, null),
064                new FieldDefinition("Description", FieldType.STRING, false, 1L, 132L),
065                new FieldDefinition("OverviewMimeTypeName", FieldType.MIME_TYPE, false, null, null),
066                new FieldDefinition("Overview", FieldType.STRING, false, null, null),
067                new FieldDefinition("IntroductionMimeTypeName", FieldType.MIME_TYPE, false, null, null),
068                new FieldDefinition("Introduction", FieldType.STRING, false, null, null)
069                ));
070    }
071    
072    /** Creates a new instance of CreateTrainingClassSectionCommand */
073    public CreateTrainingClassSectionCommand(UserVisitPK userVisitPK, CreateTrainingClassSectionForm form) {
074        super(userVisitPK, form, COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
075    }
076    
077    @Override
078    protected BaseResult execute() {
079        var trainingControl = Session.getModelController(TrainingControl.class);
080        String trainingClassName = form.getTrainingClassName();
081        TrainingClass trainingClass = trainingControl.getTrainingClassByName(trainingClassName);
082
083        if(trainingClass != null) {
084            String trainingClassSectionName = form.getTrainingClassSectionName();
085            TrainingClassSection trainingClassSection = trainingControl.getTrainingClassSectionByName(trainingClass, trainingClassSectionName);
086
087            if(trainingClassSection == null) {
088                MimeTypeLogic mimeTypeLogic = MimeTypeLogic.getInstance();
089                String overview = form.getOverview();
090                MimeType overviewMimeType = mimeTypeLogic.checkMimeType(this, form.getOverviewMimeTypeName(), overview, MimeTypeUsageTypes.TEXT.name(),
091                        ExecutionErrors.MissingRequiredOverviewMimeTypeName.name(), ExecutionErrors.MissingRequiredOverview.name(),
092                        ExecutionErrors.UnknownOverviewMimeTypeName.name(), ExecutionErrors.UnknownOverviewMimeTypeUsage.name());
093
094                if(!hasExecutionErrors()) {
095                    String introduction = form.getIntroduction();
096                    MimeType introductionMimeType = mimeTypeLogic.checkMimeType(this, form.getIntroductionMimeTypeName(), introduction, MimeTypeUsageTypes.TEXT.name(),
097                            ExecutionErrors.MissingRequiredIntroductionMimeTypeName.name(), ExecutionErrors.MissingRequiredIntroduction.name(),
098                            ExecutionErrors.UnknownIntroductionMimeTypeName.name(), ExecutionErrors.UnknownIntroductionMimeTypeUsage.name());
099
100                    if(!hasExecutionErrors()) {
101                        PartyPK createdBy = getPartyPK();
102                        String strPercentageToPass = form.getPercentageToPass();
103                        Integer percentageToPass = strPercentageToPass == null ? null : Integer.valueOf(strPercentageToPass);
104                        String strQuestionCount = form.getQuestionCount();
105                        Integer questionCount = strQuestionCount == null ? null : Integer.valueOf(strQuestionCount);
106                        var sortOrder = Integer.valueOf(form.getSortOrder());
107                        var description = form.getDescription();
108
109                        trainingClassSection = trainingControl.createTrainingClassSection(trainingClass, trainingClassSectionName, percentageToPass,
110                                questionCount, sortOrder, createdBy);
111
112                        if(description != null || overview != null || introduction != null) {
113                            trainingControl.createTrainingClassSectionTranslation(trainingClassSection, getPreferredLanguage(), description, overviewMimeType,
114                                    overview, introductionMimeType, introduction, createdBy);
115                        }
116                    }
117                }
118            } else {
119                addExecutionError(ExecutionErrors.DuplicateTrainingClassSectionName.name(), trainingClassName, trainingClassSectionName);
120            }
121        } else {
122            addExecutionError(ExecutionErrors.UnknownTrainingClassName.name(), trainingClassName);
123        }
124
125        return null;
126    }
127    
128}