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.edit.TrainingClassSectionTranslationEdit;
020import com.echothree.control.user.training.common.edit.TrainingEditFactory;
021import com.echothree.control.user.training.common.form.EditTrainingClassSectionTranslationForm;
022import com.echothree.control.user.training.common.result.EditTrainingClassSectionTranslationResult;
023import com.echothree.control.user.training.common.result.TrainingResultFactory;
024import com.echothree.control.user.training.common.spec.TrainingClassSectionTranslationSpec;
025import com.echothree.model.control.core.common.MimeTypeUsageTypes;
026import com.echothree.model.control.core.server.logic.MimeTypeLogic;
027import com.echothree.model.control.party.common.PartyTypes;
028import com.echothree.model.control.party.server.control.PartyControl;
029import com.echothree.model.control.security.common.SecurityRoleGroups;
030import com.echothree.model.control.security.common.SecurityRoles;
031import com.echothree.model.control.training.server.control.TrainingControl;
032import com.echothree.model.data.core.server.entity.MimeType;
033import com.echothree.model.data.training.server.entity.TrainingClass;
034import com.echothree.model.data.training.server.entity.TrainingClassSection;
035import com.echothree.model.data.training.server.entity.TrainingClassSectionTranslation;
036import com.echothree.model.data.user.common.pk.UserVisitPK;
037import com.echothree.util.common.message.ExecutionErrors;
038import com.echothree.util.common.validation.FieldDefinition;
039import com.echothree.util.common.validation.FieldType;
040import com.echothree.util.common.command.EditMode;
041import com.echothree.util.server.control.BaseAbstractEditCommand;
042import com.echothree.util.server.control.CommandSecurityDefinition;
043import com.echothree.util.server.control.PartyTypeDefinition;
044import com.echothree.util.server.control.SecurityRoleDefinition;
045import com.echothree.util.server.persistence.Session;
046import java.util.List;
047import javax.enterprise.context.Dependent;
048
049@Dependent
050public class EditTrainingClassSectionTranslationCommand
051        extends BaseAbstractEditCommand<TrainingClassSectionTranslationSpec, TrainingClassSectionTranslationEdit, EditTrainingClassSectionTranslationResult, TrainingClassSectionTranslation, TrainingClassSection> {
052
053    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
054    private final static List<FieldDefinition> SPEC_FIELD_DEFINITIONS;
055    private final static List<FieldDefinition> EDIT_FIELD_DEFINITIONS;
056
057    static {
058        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(List.of(
059                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
060                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
061                        new SecurityRoleDefinition(SecurityRoleGroups.TrainingClassSection.name(), SecurityRoles.Translation.name())
062                        ))
063                ));
064
065        SPEC_FIELD_DEFINITIONS = List.of(
066                new FieldDefinition("TrainingClassName", FieldType.ENTITY_NAME, true, null, null),
067                new FieldDefinition("TrainingClassSectionName", FieldType.ENTITY_NAME, true, null, null),
068                new FieldDefinition("LanguageIsoName", FieldType.ENTITY_NAME, true, null, null)
069                );
070
071        EDIT_FIELD_DEFINITIONS = List.of(
072                new FieldDefinition("Description", FieldType.STRING, true, 1L, 132L),
073                new FieldDefinition("OverviewMimeTypeName", FieldType.MIME_TYPE, false, null, null),
074                new FieldDefinition("Overview", FieldType.STRING, false, null, null),
075                new FieldDefinition("IntroductionMimeTypeName", FieldType.MIME_TYPE, false, null, null),
076                new FieldDefinition("Introduction", FieldType.STRING, false, null, null)
077                );
078    }
079
080    /** Creates a new instance of EditTrainingClassSectionTranslationCommand */
081    public EditTrainingClassSectionTranslationCommand() {
082        super(COMMAND_SECURITY_DEFINITION, SPEC_FIELD_DEFINITIONS, EDIT_FIELD_DEFINITIONS);
083    }
084
085    @Override
086    public EditTrainingClassSectionTranslationResult getResult() {
087        return TrainingResultFactory.getEditTrainingClassSectionTranslationResult();
088    }
089
090    @Override
091    public TrainingClassSectionTranslationEdit getEdit() {
092        return TrainingEditFactory.getTrainingClassSectionTranslationEdit();
093    }
094
095    TrainingClass trainingClass;
096    
097    @Override
098    public TrainingClassSectionTranslation getEntity(EditTrainingClassSectionTranslationResult result) {
099        var trainingControl = Session.getModelController(TrainingControl.class);
100        TrainingClassSectionTranslation trainingClassSectionTranslation = null;
101        var trainingClassName = spec.getTrainingClassName();
102        
103        trainingClass = trainingControl.getTrainingClassByName(trainingClassName);
104
105        if(trainingClass != null) {
106            var trainingClassSectionName = spec.getTrainingClassSectionName();
107            var trainingClassSection = trainingControl.getTrainingClassSectionByName(trainingClass, trainingClassSectionName);
108
109            if(trainingClassSection != null) {
110                var partyControl = Session.getModelController(PartyControl.class);
111                var languageIsoName = spec.getLanguageIsoName();
112                var language = partyControl.getLanguageByIsoName(languageIsoName);
113
114                if(language != null) {
115                    if(editMode.equals(EditMode.LOCK) || editMode.equals(EditMode.ABANDON)) {
116                        trainingClassSectionTranslation = trainingControl.getTrainingClassSectionTranslation(trainingClassSection, language);
117                    } else { // EditMode.UPDATE
118                        trainingClassSectionTranslation = trainingControl.getTrainingClassSectionTranslationForUpdate(trainingClassSection, language);
119                    }
120
121                    if(trainingClassSectionTranslation == null) {
122                        addExecutionError(ExecutionErrors.UnknownTrainingClassSectionTranslation.name(), trainingClassName, trainingClassSectionName, languageIsoName);
123                    }
124                } else {
125                    addExecutionError(ExecutionErrors.UnknownLanguageIsoName.name(), languageIsoName);
126                }
127            } else {
128                addExecutionError(ExecutionErrors.UnknownTrainingClassSectionName.name(), trainingClassName, trainingClassSectionName);
129            }
130        } else {
131            addExecutionError(ExecutionErrors.UnknownTrainingClassName.name(), trainingClassName);
132        }
133
134        return trainingClassSectionTranslation;
135    }
136
137    @Override
138    public TrainingClassSection getLockEntity(TrainingClassSectionTranslation trainingClassSectionTranslation) {
139        return trainingClassSectionTranslation.getTrainingClassSection();
140    }
141
142    @Override
143    public void fillInResult(EditTrainingClassSectionTranslationResult result, TrainingClassSectionTranslation trainingClassSectionTranslation) {
144        var trainingControl = Session.getModelController(TrainingControl.class);
145
146        result.setTrainingClassSectionTranslation(trainingControl.getTrainingClassSectionTranslationTransfer(getUserVisit(), trainingClassSectionTranslation));
147    }
148
149    MimeType overviewMimeType;
150    MimeType introductionMimeType;
151    
152    @Override
153    public void doLock(TrainingClassSectionTranslationEdit edit, TrainingClassSectionTranslation trainingClassSectionTranslation) {
154        overviewMimeType = trainingClassSectionTranslation.getOverviewMimeType();
155        introductionMimeType = trainingClassSectionTranslation.getIntroductionMimeType();
156        
157        edit.setDescription(trainingClassSectionTranslation.getDescription());
158        edit.setOverviewMimeTypeName(overviewMimeType == null? null: overviewMimeType.getLastDetail().getMimeTypeName());
159        edit.setOverview(trainingClassSectionTranslation.getOverview());
160        edit.setIntroductionMimeTypeName(introductionMimeType == null? null: introductionMimeType.getLastDetail().getMimeTypeName());
161        edit.setIntroduction(trainingClassSectionTranslation.getIntroduction());
162    }
163
164    @Override
165    protected void canUpdate(TrainingClassSectionTranslation trainingClassSectionTranslation) {
166        var mimeTypeLogic = MimeTypeLogic.getInstance();
167        var overviewMimeTypeName = edit.getOverviewMimeTypeName();
168        var overview = edit.getOverview();
169        
170        overviewMimeType = mimeTypeLogic.checkMimeType(this, overviewMimeTypeName, overview, MimeTypeUsageTypes.TEXT.name(),
171                ExecutionErrors.MissingRequiredOverviewMimeTypeName.name(), ExecutionErrors.MissingRequiredOverview.name(),
172                ExecutionErrors.UnknownOverviewMimeTypeName.name(), ExecutionErrors.UnknownOverviewMimeTypeUsage.name());
173        
174        if(!hasExecutionErrors()) {
175            var introductionMimeTypeName = edit.getIntroductionMimeTypeName();
176            var introduction = edit.getIntroduction();
177
178            introductionMimeType = mimeTypeLogic.checkMimeType(this, introductionMimeTypeName, introduction, MimeTypeUsageTypes.TEXT.name(),
179                    ExecutionErrors.MissingRequiredIntroductionMimeTypeName.name(), ExecutionErrors.MissingRequiredIntroduction.name(),
180                    ExecutionErrors.UnknownIntroductionMimeTypeName.name(), ExecutionErrors.UnknownIntroductionMimeTypeUsage.name());
181        }
182    }
183    
184    @Override
185    public void doUpdate(TrainingClassSectionTranslation trainingClassSectionTranslation) {
186        var trainingControl = Session.getModelController(TrainingControl.class);
187        var trainingClassSectionTranslationValue = trainingControl.getTrainingClassSectionTranslationValue(trainingClassSectionTranslation);
188        
189        trainingClassSectionTranslationValue.setDescription(edit.getDescription());
190        trainingClassSectionTranslationValue.setOverviewMimeTypePK(overviewMimeType == null? null: overviewMimeType.getPrimaryKey());
191        trainingClassSectionTranslationValue.setOverview(edit.getOverview());
192        trainingClassSectionTranslationValue.setIntroductionMimeTypePK(introductionMimeType == null? null: introductionMimeType.getPrimaryKey());
193        trainingClassSectionTranslationValue.setIntroduction(edit.getIntroduction());
194        
195        trainingControl.updateTrainingClassSectionTranslationFromValue(trainingClassSectionTranslationValue, getPartyPK());
196    }
197
198}