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 com.echothree.util.server.persistence.Session;
045import java.util.List;
046import javax.enterprise.context.Dependent;
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    /** Creates a new instance of EditTrainingClassTranslationCommand */
079    public EditTrainingClassTranslationCommand() {
080        super(COMMAND_SECURITY_DEFINITION, SPEC_FIELD_DEFINITIONS, EDIT_FIELD_DEFINITIONS);
081    }
082
083    @Override
084    public EditTrainingClassTranslationResult getResult() {
085        return TrainingResultFactory.getEditTrainingClassTranslationResult();
086    }
087
088    @Override
089    public TrainingClassTranslationEdit getEdit() {
090        return TrainingEditFactory.getTrainingClassTranslationEdit();
091    }
092
093    @Override
094    public TrainingClassTranslation getEntity(EditTrainingClassTranslationResult result) {
095        var trainingControl = Session.getModelController(TrainingControl.class);
096        TrainingClassTranslation trainingClassTranslation = null;
097        var trainingClassName = spec.getTrainingClassName();
098        var trainingClass = trainingControl.getTrainingClassByName(trainingClassName);
099
100        if(trainingClass != null) {
101            var partyControl = Session.getModelController(PartyControl.class);
102            var languageIsoName = spec.getLanguageIsoName();
103            var language = partyControl.getLanguageByIsoName(languageIsoName);
104
105            if(language != null) {
106                if(editMode.equals(EditMode.LOCK) || editMode.equals(EditMode.ABANDON)) {
107                    trainingClassTranslation = trainingControl.getTrainingClassTranslation(trainingClass, language);
108                } else { // EditMode.UPDATE
109                    trainingClassTranslation = trainingControl.getTrainingClassTranslationForUpdate(trainingClass, language);
110                }
111
112                if(trainingClassTranslation == null) {
113                    addExecutionError(ExecutionErrors.UnknownTrainingClassTranslation.name(), trainingClassName, languageIsoName);
114                }
115            } else {
116                addExecutionError(ExecutionErrors.UnknownLanguageIsoName.name(), languageIsoName);
117            }
118        } else {
119            addExecutionError(ExecutionErrors.UnknownTrainingClassName.name(), trainingClassName);
120        }
121
122        return trainingClassTranslation;
123    }
124
125    @Override
126    public TrainingClass getLockEntity(TrainingClassTranslation trainingClassTranslation) {
127        return trainingClassTranslation.getTrainingClass();
128    }
129
130    @Override
131    public void fillInResult(EditTrainingClassTranslationResult result, TrainingClassTranslation trainingClassTranslation) {
132        var trainingControl = Session.getModelController(TrainingControl.class);
133
134        result.setTrainingClassTranslation(trainingControl.getTrainingClassTranslationTransfer(getUserVisit(), trainingClassTranslation));
135    }
136
137    MimeType overviewMimeType;
138    MimeType introductionMimeType;
139    
140    @Override
141    public void doLock(TrainingClassTranslationEdit edit, TrainingClassTranslation trainingClassTranslation) {
142        overviewMimeType = trainingClassTranslation.getOverviewMimeType();
143        introductionMimeType = trainingClassTranslation.getIntroductionMimeType();
144        
145        edit.setDescription(trainingClassTranslation.getDescription());
146        edit.setOverviewMimeTypeName(overviewMimeType == null? null: overviewMimeType.getLastDetail().getMimeTypeName());
147        edit.setOverview(trainingClassTranslation.getOverview());
148        edit.setIntroductionMimeTypeName(introductionMimeType == null? null: introductionMimeType.getLastDetail().getMimeTypeName());
149        edit.setIntroduction(trainingClassTranslation.getIntroduction());
150    }
151
152    @Override
153    protected void canUpdate(TrainingClassTranslation trainingClassTranslation) {
154        var mimeTypeLogic = MimeTypeLogic.getInstance();
155        var overviewMimeTypeName = edit.getOverviewMimeTypeName();
156        var overview = edit.getOverview();
157        
158        overviewMimeType = mimeTypeLogic.checkMimeType(this, overviewMimeTypeName, overview, MimeTypeUsageTypes.TEXT.name(),
159                ExecutionErrors.MissingRequiredOverviewMimeTypeName.name(), ExecutionErrors.MissingRequiredOverview.name(),
160                ExecutionErrors.UnknownOverviewMimeTypeName.name(), ExecutionErrors.UnknownOverviewMimeTypeUsage.name());
161        
162        if(!hasExecutionErrors()) {
163            var introductionMimeTypeName = edit.getIntroductionMimeTypeName();
164            var introduction = edit.getIntroduction();
165
166            introductionMimeType = mimeTypeLogic.checkMimeType(this, introductionMimeTypeName, introduction, MimeTypeUsageTypes.TEXT.name(),
167                    ExecutionErrors.MissingRequiredIntroductionMimeTypeName.name(), ExecutionErrors.MissingRequiredIntroduction.name(),
168                    ExecutionErrors.UnknownIntroductionMimeTypeName.name(), ExecutionErrors.UnknownIntroductionMimeTypeUsage.name());
169        }
170    }
171    
172    @Override
173    public void doUpdate(TrainingClassTranslation trainingClassTranslation) {
174        var trainingControl = Session.getModelController(TrainingControl.class);
175        var trainingClassTranslationValue = trainingControl.getTrainingClassTranslationValue(trainingClassTranslation);
176        
177        trainingClassTranslationValue.setDescription(edit.getDescription());
178        trainingClassTranslationValue.setOverviewMimeTypePK(overviewMimeType == null? null: overviewMimeType.getPrimaryKey());
179        trainingClassTranslationValue.setOverview(edit.getOverview());
180        trainingClassTranslationValue.setIntroductionMimeTypePK(introductionMimeType == null? null: introductionMimeType.getPrimaryKey());
181        trainingClassTranslationValue.setIntroduction(edit.getIntroduction());
182        
183        trainingControl.updateTrainingClassTranslationFromValue(trainingClassTranslationValue, getPartyPK());
184    }
185
186}