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.CreateTrainingClassPageForm;
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.TrainingClassPage;
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 CreateTrainingClassPageCommand
043        extends BaseSimpleCommand<CreateTrainingClassPageForm> {
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.TrainingClassPage.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("TrainingClassPageName", FieldType.ENTITY_NAME, true, null, null),
060                new FieldDefinition("PercentageToPass", FieldType.FRACTIONAL_PERCENT, false, null, null),
061                new FieldDefinition("QuestionCount", FieldType.UNSIGNED_INTEGER, false, null, null),
062                new FieldDefinition("SortOrder", FieldType.SIGNED_INTEGER, true, null, null),
063                new FieldDefinition("Description", FieldType.STRING, false, 1L, 132L),
064                new FieldDefinition("PageMimeTypeName", FieldType.MIME_TYPE, false, null, null),
065                new FieldDefinition("Page", FieldType.STRING, false, null, null)
066        );
067    }
068
069    @Inject
070    TrainingControl trainingControl;
071
072    @Inject
073    MimeTypeLogic mimeTypeLogic;
074
075    
076    /** Creates a new instance of CreateTrainingClassPageCommand */
077    public CreateTrainingClassPageCommand() {
078        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
079    }
080    
081    @Override
082    protected BaseResult execute() {
083        var result = TrainingResultFactory.getCreateTrainingClassPageResult();
084        TrainingClassPage trainingClassPage = null;
085        var trainingClassName = form.getTrainingClassName();
086        var trainingClass = trainingControl.getTrainingClassByName(trainingClassName);
087
088        if(trainingClass != null) {
089            var trainingClassSectionName = form.getTrainingClassSectionName();
090            var trainingClassSection = trainingControl.getTrainingClassSectionByName(trainingClass, trainingClassSectionName);
091
092            if(trainingClassSection != null) {
093                var trainingClassPageName = form.getTrainingClassPageName();
094
095                trainingClassPage = trainingControl.getTrainingClassPageByName(trainingClassSection, trainingClassPageName);
096
097                if(trainingClassPage == null) {
098                    var page = form.getPage();
099                    var pageMimeType = mimeTypeLogic.checkMimeType(this, form.getPageMimeTypeName(), page, MimeTypeUsageTypes.TEXT.name(),
100                            ExecutionErrors.MissingRequiredPageMimeTypeName.name(), ExecutionErrors.MissingRequiredPage.name(),
101                            ExecutionErrors.UnknownPageMimeTypeName.name(), ExecutionErrors.UnknownPageMimeTypeUsage.name());
102
103                    if(!hasExecutionErrors()) {
104                        var createdBy = getPartyPK();
105                        var sortOrder = Integer.valueOf(form.getSortOrder());
106                        var description = form.getDescription();
107
108                        trainingClassPage = trainingControl.createTrainingClassPage(trainingClassSection, trainingClassPageName, sortOrder, createdBy);
109
110                        if(description != null || page != null) {
111                            trainingControl.createTrainingClassPageTranslation(trainingClassPage, getPreferredLanguage(), description, pageMimeType,
112                                    page, createdBy);
113                        }
114                    }
115                } else {
116                    addExecutionError(ExecutionErrors.DuplicateTrainingClassPageName.name(), trainingClassName, trainingClassPageName);
117                }
118            } else {
119                addExecutionError(ExecutionErrors.UnknownTrainingClassSectionName.name(), trainingClassName, trainingClassSectionName);
120            }
121        } else {
122            addExecutionError(ExecutionErrors.UnknownTrainingClassName.name(), trainingClassName);
123        }
124
125        if(trainingClassPage != null) {
126            result.setEntityRef(trainingClassPage.getPrimaryKey().getEntityRef());
127            result.setTrainingClassName(trainingClassPage.getLastDetail().getTrainingClassSection().getLastDetail().getTrainingClass().getLastDetail().getTrainingClassName());
128            result.setTrainingClassSectionName(trainingClassPage.getLastDetail().getTrainingClassSection().getLastDetail().getTrainingClassSectionName());
129            result.setTrainingClassPageName(trainingClassPage.getLastDetail().getTrainingClassPageName());
130        }
131
132        return result;
133    }
134    
135}