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