Source code

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