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 java.util.List;
046import javax.enterprise.context.Dependent;
047import javax.inject.Inject;
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    @Inject
081    PartyControl partyControl;
082
083    @Inject
084    TrainingControl trainingControl;
085
086    @Inject
087    MimeTypeLogic mimeTypeLogic;
088
089    /** Creates a new instance of EditTrainingClassSectionTranslationCommand */
090    public EditTrainingClassSectionTranslationCommand() {
091        super(COMMAND_SECURITY_DEFINITION, SPEC_FIELD_DEFINITIONS, EDIT_FIELD_DEFINITIONS);
092    }
093
094    @Override
095    public EditTrainingClassSectionTranslationResult getResult() {
096        return TrainingResultFactory.getEditTrainingClassSectionTranslationResult();
097    }
098
099    @Override
100    public TrainingClassSectionTranslationEdit getEdit() {
101        return TrainingEditFactory.getTrainingClassSectionTranslationEdit();
102    }
103
104    TrainingClass trainingClass;
105    
106    @Override
107    public TrainingClassSectionTranslation getEntity(EditTrainingClassSectionTranslationResult result) {
108        TrainingClassSectionTranslation trainingClassSectionTranslation = null;
109        var trainingClassName = spec.getTrainingClassName();
110        
111        trainingClass = trainingControl.getTrainingClassByName(trainingClassName);
112
113        if(trainingClass != null) {
114            var trainingClassSectionName = spec.getTrainingClassSectionName();
115            var trainingClassSection = trainingControl.getTrainingClassSectionByName(trainingClass, trainingClassSectionName);
116
117            if(trainingClassSection != null) {
118                var languageIsoName = spec.getLanguageIsoName();
119                var language = partyControl.getLanguageByIsoName(languageIsoName);
120
121                if(language != null) {
122                    if(editMode.equals(EditMode.LOCK) || editMode.equals(EditMode.ABANDON)) {
123                        trainingClassSectionTranslation = trainingControl.getTrainingClassSectionTranslation(trainingClassSection, language);
124                    } else { // EditMode.UPDATE
125                        trainingClassSectionTranslation = trainingControl.getTrainingClassSectionTranslationForUpdate(trainingClassSection, language);
126                    }
127
128                    if(trainingClassSectionTranslation == null) {
129                        addExecutionError(ExecutionErrors.UnknownTrainingClassSectionTranslation.name(), trainingClassName, trainingClassSectionName, languageIsoName);
130                    }
131                } else {
132                    addExecutionError(ExecutionErrors.UnknownLanguageIsoName.name(), languageIsoName);
133                }
134            } else {
135                addExecutionError(ExecutionErrors.UnknownTrainingClassSectionName.name(), trainingClassName, trainingClassSectionName);
136            }
137        } else {
138            addExecutionError(ExecutionErrors.UnknownTrainingClassName.name(), trainingClassName);
139        }
140
141        return trainingClassSectionTranslation;
142    }
143
144    @Override
145    public TrainingClassSection getLockEntity(TrainingClassSectionTranslation trainingClassSectionTranslation) {
146        return trainingClassSectionTranslation.getTrainingClassSection();
147    }
148
149    @Override
150    public void fillInResult(EditTrainingClassSectionTranslationResult result, TrainingClassSectionTranslation trainingClassSectionTranslation) {
151        result.setTrainingClassSectionTranslation(trainingControl.getTrainingClassSectionTranslationTransfer(getUserVisit(), trainingClassSectionTranslation));
152    }
153
154    MimeType overviewMimeType;
155    MimeType introductionMimeType;
156    
157    @Override
158    public void doLock(TrainingClassSectionTranslationEdit edit, TrainingClassSectionTranslation trainingClassSectionTranslation) {
159        overviewMimeType = trainingClassSectionTranslation.getOverviewMimeType();
160        introductionMimeType = trainingClassSectionTranslation.getIntroductionMimeType();
161        
162        edit.setDescription(trainingClassSectionTranslation.getDescription());
163        edit.setOverviewMimeTypeName(overviewMimeType == null? null: overviewMimeType.getLastDetail().getMimeTypeName());
164        edit.setOverview(trainingClassSectionTranslation.getOverview());
165        edit.setIntroductionMimeTypeName(introductionMimeType == null? null: introductionMimeType.getLastDetail().getMimeTypeName());
166        edit.setIntroduction(trainingClassSectionTranslation.getIntroduction());
167    }
168
169    @Override
170    protected void canUpdate(TrainingClassSectionTranslation trainingClassSectionTranslation) {
171        var overviewMimeTypeName = edit.getOverviewMimeTypeName();
172        var overview = edit.getOverview();
173        
174        overviewMimeType = mimeTypeLogic.checkMimeType(this, overviewMimeTypeName, overview, MimeTypeUsageTypes.TEXT.name(),
175                ExecutionErrors.MissingRequiredOverviewMimeTypeName.name(), ExecutionErrors.MissingRequiredOverview.name(),
176                ExecutionErrors.UnknownOverviewMimeTypeName.name(), ExecutionErrors.UnknownOverviewMimeTypeUsage.name());
177        
178        if(!hasExecutionErrors()) {
179            var introductionMimeTypeName = edit.getIntroductionMimeTypeName();
180            var introduction = edit.getIntroduction();
181
182            introductionMimeType = mimeTypeLogic.checkMimeType(this, introductionMimeTypeName, introduction, MimeTypeUsageTypes.TEXT.name(),
183                    ExecutionErrors.MissingRequiredIntroductionMimeTypeName.name(), ExecutionErrors.MissingRequiredIntroduction.name(),
184                    ExecutionErrors.UnknownIntroductionMimeTypeName.name(), ExecutionErrors.UnknownIntroductionMimeTypeUsage.name());
185        }
186    }
187    
188    @Override
189    public void doUpdate(TrainingClassSectionTranslation trainingClassSectionTranslation) {
190        var trainingClassSectionTranslationValue = trainingControl.getTrainingClassSectionTranslationValue(trainingClassSectionTranslation);
191        
192        trainingClassSectionTranslationValue.setDescription(edit.getDescription());
193        trainingClassSectionTranslationValue.setOverviewMimeTypePK(overviewMimeType == null? null: overviewMimeType.getPrimaryKey());
194        trainingClassSectionTranslationValue.setOverview(edit.getOverview());
195        trainingClassSectionTranslationValue.setIntroductionMimeTypePK(introductionMimeType == null? null: introductionMimeType.getPrimaryKey());
196        trainingClassSectionTranslationValue.setIntroduction(edit.getIntroduction());
197        
198        trainingControl.updateTrainingClassSectionTranslationFromValue(trainingClassSectionTranslationValue, getPartyPK());
199    }
200
201}