001// --------------------------------------------------------------------------------
002// Copyright 2002-2025 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.TrainingClassQuestionEdit;
020import com.echothree.control.user.training.common.edit.TrainingEditFactory;
021import com.echothree.control.user.training.common.form.EditTrainingClassQuestionForm;
022import com.echothree.control.user.training.common.result.EditTrainingClassQuestionResult;
023import com.echothree.control.user.training.common.result.TrainingResultFactory;
024import com.echothree.control.user.training.common.spec.TrainingClassQuestionSpec;
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.security.common.SecurityRoleGroups;
029import com.echothree.model.control.security.common.SecurityRoles;
030import com.echothree.model.control.training.server.control.TrainingControl;
031import com.echothree.model.data.core.server.entity.MimeType;
032import com.echothree.model.data.training.server.entity.TrainingClassQuestion;
033import com.echothree.model.data.training.server.entity.TrainingClassSection;
034import com.echothree.model.data.user.common.pk.UserVisitPK;
035import com.echothree.util.common.message.ExecutionErrors;
036import com.echothree.util.common.validation.FieldDefinition;
037import com.echothree.util.common.validation.FieldType;
038import com.echothree.util.common.command.EditMode;
039import com.echothree.util.server.control.BaseAbstractEditCommand;
040import com.echothree.util.server.control.CommandSecurityDefinition;
041import com.echothree.util.server.control.PartyTypeDefinition;
042import com.echothree.util.server.control.SecurityRoleDefinition;
043import com.echothree.util.server.persistence.Session;
044import java.util.Arrays;
045import java.util.Collections;
046import java.util.List;
047import javax.enterprise.context.RequestScoped;
048
049@RequestScoped
050public class EditTrainingClassQuestionCommand
051        extends BaseAbstractEditCommand<TrainingClassQuestionSpec, TrainingClassQuestionEdit, EditTrainingClassQuestionResult, TrainingClassQuestion, TrainingClassQuestion> {
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(Collections.unmodifiableList(Arrays.asList(
059                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
060                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), Collections.unmodifiableList(Arrays.asList(
061                        new SecurityRoleDefinition(SecurityRoleGroups.TrainingClassQuestion.name(), SecurityRoles.Edit.name())
062                        )))
063                )));
064
065        SPEC_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
066                new FieldDefinition("TrainingClassName", FieldType.ENTITY_NAME, true, null, null),
067                new FieldDefinition("TrainingClassSectionName", FieldType.ENTITY_NAME, true, null, null),
068                new FieldDefinition("TrainingClassQuestionName", FieldType.ENTITY_NAME, true, null, null)
069                ));
070
071        EDIT_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
072                new FieldDefinition("TrainingClassQuestionName", FieldType.ENTITY_NAME, true, null, null),
073                new FieldDefinition("AskingRequired", FieldType.BOOLEAN, true, null, null),
074                new FieldDefinition("PassingRequired", FieldType.BOOLEAN, true, null, null),
075                new FieldDefinition("SortOrder", FieldType.SIGNED_INTEGER, true, null, null),
076                new FieldDefinition("QuestionMimeTypeName", FieldType.MIME_TYPE, false, null, null),
077                new FieldDefinition("Question", FieldType.STRING, false, null, null)
078                ));
079    }
080    
081    /** Creates a new instance of EditTrainingClassQuestionCommand */
082    public EditTrainingClassQuestionCommand() {
083        super(COMMAND_SECURITY_DEFINITION, SPEC_FIELD_DEFINITIONS, EDIT_FIELD_DEFINITIONS);
084    }
085    
086    @Override
087    public EditTrainingClassQuestionResult getResult() {
088        return TrainingResultFactory.getEditTrainingClassQuestionResult();
089    }
090
091    @Override
092    public TrainingClassQuestionEdit getEdit() {
093        return TrainingEditFactory.getTrainingClassQuestionEdit();
094    }
095
096    TrainingClassSection trainingClassSection;
097    
098    @Override
099    public TrainingClassQuestion getEntity(EditTrainingClassQuestionResult result) {
100        var trainingControl = Session.getModelController(TrainingControl.class);
101        TrainingClassQuestion trainingClassQuestion = null;
102        var trainingClassName = spec.getTrainingClassName();
103        var trainingClass = trainingControl.getTrainingClassByName(trainingClassName);
104
105        if(trainingClass != null) {
106            var trainingClassSectionName = spec.getTrainingClassSectionName();
107            
108            trainingClassSection = trainingControl.getTrainingClassSectionByName(trainingClass, trainingClassSectionName);
109
110            if(trainingClassSection != null) {
111                var trainingClassQuestionName = spec.getTrainingClassQuestionName();
112
113                if(editMode.equals(EditMode.LOCK) || editMode.equals(EditMode.ABANDON)) {
114                    trainingClassQuestion = trainingControl.getTrainingClassQuestionByName(trainingClassSection, trainingClassQuestionName);
115                } else { // EditMode.UPDATE
116                    trainingClassQuestion = trainingControl.getTrainingClassQuestionByNameForUpdate(trainingClassSection, trainingClassQuestionName);
117                }
118
119                if(trainingClassQuestion != null) {
120                    result.setTrainingClassQuestion(trainingControl.getTrainingClassQuestionTransfer(getUserVisit(), trainingClassQuestion));
121                } else {
122                    addExecutionError(ExecutionErrors.UnknownTrainingClassQuestionName.name(), trainingClassName, trainingClassQuestionName);
123                }
124            } else {
125                addExecutionError(ExecutionErrors.UnknownTrainingClassSectionName.name(), trainingClassName, trainingClassSectionName);
126            }
127        } else {
128            addExecutionError(ExecutionErrors.UnknownTrainingClassName.name(), trainingClassName);
129        }
130
131        return trainingClassQuestion;
132    }
133
134    @Override
135    public TrainingClassQuestion getLockEntity(TrainingClassQuestion trainingClassQuestion) {
136        return trainingClassQuestion;
137    }
138
139    @Override
140    public void fillInResult(EditTrainingClassQuestionResult result, TrainingClassQuestion trainingClassQuestion) {
141        var trainingControl = Session.getModelController(TrainingControl.class);
142
143        result.setTrainingClassQuestion(trainingControl.getTrainingClassQuestionTransfer(getUserVisit(), trainingClassQuestion));
144    }
145
146    MimeType questionMimeType;
147    
148    @Override
149    public void doLock(TrainingClassQuestionEdit edit, TrainingClassQuestion trainingClassQuestion) {
150        var trainingControl = Session.getModelController(TrainingControl.class);
151        var trainingClassQuestionTranslation = trainingControl.getTrainingClassQuestionTranslation(trainingClassQuestion, getPreferredLanguage());
152        var trainingClassQuestionDetail = trainingClassQuestion.getLastDetail();
153
154        edit.setTrainingClassQuestionName(trainingClassQuestionDetail.getTrainingClassQuestionName());
155        edit.setAskingRequired(trainingClassQuestionDetail.getAskingRequired().toString());
156        edit.setPassingRequired(trainingClassQuestionDetail.getPassingRequired().toString());
157        edit.setSortOrder(trainingClassQuestionDetail.getSortOrder().toString());
158
159        if(trainingClassQuestionTranslation != null) {
160            edit.setQuestionMimeTypeName(trainingClassQuestionTranslation.getQuestionMimeType().getLastDetail().getMimeTypeName());
161            edit.setQuestion(trainingClassQuestionTranslation.getQuestion());
162        }
163    }
164
165    @Override
166    public void canUpdate(TrainingClassQuestion trainingClassQuestion) {
167        var trainingControl = Session.getModelController(TrainingControl.class);
168        var trainingClassQuestionName = edit.getTrainingClassQuestionName();
169        var duplicateTrainingClassQuestion = trainingControl.getTrainingClassQuestionByName(trainingClassSection, trainingClassQuestionName);
170
171        if(duplicateTrainingClassQuestion != null && !trainingClassQuestion.equals(duplicateTrainingClassQuestion)) {
172            addExecutionError(ExecutionErrors.DuplicateTrainingClassQuestionName.name(), trainingClassQuestionName);
173        } else {
174            var mimeTypeLogic = MimeTypeLogic.getInstance();
175            var questionMimeTypeName = edit.getQuestionMimeTypeName();
176            var question = edit.getQuestion();
177
178            questionMimeType = mimeTypeLogic.checkMimeType(this, questionMimeTypeName, question, MimeTypeUsageTypes.TEXT.name(),
179                    ExecutionErrors.MissingRequiredQuestionMimeTypeName.name(), ExecutionErrors.MissingRequiredQuestion.name(),
180                    ExecutionErrors.UnknownQuestionMimeTypeName.name(), ExecutionErrors.UnknownQuestionMimeTypeUsage.name());
181        }
182    }
183    
184    @Override
185    public void doUpdate(TrainingClassQuestion trainingClassQuestion) {
186        var trainingControl = Session.getModelController(TrainingControl.class);
187        var partyPK = getPartyPK();
188        var trainingClassQuestionDetailValue = trainingControl.getTrainingClassQuestionDetailValueForUpdate(trainingClassQuestion);
189        var trainingClassQuestionTranslation = trainingControl.getTrainingClassQuestionTranslationForUpdate(trainingClassQuestion, getPreferredLanguage());
190        var question = edit.getQuestion();
191
192        trainingClassQuestionDetailValue.setTrainingClassQuestionName(edit.getTrainingClassQuestionName());
193        trainingClassQuestionDetailValue.setAskingRequired(Boolean.valueOf(edit.getAskingRequired()));
194        trainingClassQuestionDetailValue.setPassingRequired(Boolean.valueOf(edit.getPassingRequired()));
195        trainingClassQuestionDetailValue.setSortOrder(Integer.valueOf(edit.getSortOrder()));
196
197        trainingControl.updateTrainingClassQuestionFromValue(trainingClassQuestionDetailValue, partyPK);
198
199        if(trainingClassQuestionTranslation == null && (question != null)) {
200            trainingControl.createTrainingClassQuestionTranslation(trainingClassQuestion, getPreferredLanguage(), questionMimeType, question, partyPK);
201        } else if(trainingClassQuestionTranslation != null && (question == null)) {
202            trainingControl.deleteTrainingClassQuestionTranslation(trainingClassQuestionTranslation, partyPK);
203        } else if(trainingClassQuestionTranslation != null && (question != null)) {
204            var trainingClassQuestionTranslationValue = trainingControl.getTrainingClassQuestionTranslationValue(trainingClassQuestionTranslation);
205
206            trainingClassQuestionTranslationValue.setQuestionMimeTypePK(questionMimeType == null? null: questionMimeType.getPrimaryKey());
207            trainingClassQuestionTranslationValue.setQuestion(question);
208            trainingControl.updateTrainingClassQuestionTranslationFromValue(trainingClassQuestionTranslationValue, partyPK);
209        }
210    }
211
212}