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