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