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 java.util.List;
044import javax.enterprise.context.Dependent;
045import javax.inject.Inject;
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    @Inject
080    TrainingControl trainingControl;
081
082    @Inject
083    MimeTypeLogic mimeTypeLogic;
084
085    
086    /** Creates a new instance of EditTrainingClassQuestionCommand */
087    public EditTrainingClassQuestionCommand() {
088        super(COMMAND_SECURITY_DEFINITION, SPEC_FIELD_DEFINITIONS, EDIT_FIELD_DEFINITIONS);
089    }
090    
091    @Override
092    public EditTrainingClassQuestionResult getResult() {
093        return TrainingResultFactory.getEditTrainingClassQuestionResult();
094    }
095
096    @Override
097    public TrainingClassQuestionEdit getEdit() {
098        return TrainingEditFactory.getTrainingClassQuestionEdit();
099    }
100
101    TrainingClassSection trainingClassSection;
102    
103    @Override
104    public TrainingClassQuestion getEntity(EditTrainingClassQuestionResult result) {
105        TrainingClassQuestion trainingClassQuestion = null;
106        var trainingClassName = spec.getTrainingClassName();
107        var trainingClass = trainingControl.getTrainingClassByName(trainingClassName);
108
109        if(trainingClass != null) {
110            var trainingClassSectionName = spec.getTrainingClassSectionName();
111            
112            trainingClassSection = trainingControl.getTrainingClassSectionByName(trainingClass, trainingClassSectionName);
113
114            if(trainingClassSection != null) {
115                var trainingClassQuestionName = spec.getTrainingClassQuestionName();
116
117                if(editMode.equals(EditMode.LOCK) || editMode.equals(EditMode.ABANDON)) {
118                    trainingClassQuestion = trainingControl.getTrainingClassQuestionByName(trainingClassSection, trainingClassQuestionName);
119                } else { // EditMode.UPDATE
120                    trainingClassQuestion = trainingControl.getTrainingClassQuestionByNameForUpdate(trainingClassSection, trainingClassQuestionName);
121                }
122
123                if(trainingClassQuestion != null) {
124                    result.setTrainingClassQuestion(trainingControl.getTrainingClassQuestionTransfer(getUserVisit(), trainingClassQuestion));
125                } else {
126                    addExecutionError(ExecutionErrors.UnknownTrainingClassQuestionName.name(), trainingClassName, trainingClassQuestionName);
127                }
128            } else {
129                addExecutionError(ExecutionErrors.UnknownTrainingClassSectionName.name(), trainingClassName, trainingClassSectionName);
130            }
131        } else {
132            addExecutionError(ExecutionErrors.UnknownTrainingClassName.name(), trainingClassName);
133        }
134
135        return trainingClassQuestion;
136    }
137
138    @Override
139    public TrainingClassQuestion getLockEntity(TrainingClassQuestion trainingClassQuestion) {
140        return trainingClassQuestion;
141    }
142
143    @Override
144    public void fillInResult(EditTrainingClassQuestionResult result, TrainingClassQuestion trainingClassQuestion) {
145        result.setTrainingClassQuestion(trainingControl.getTrainingClassQuestionTransfer(getUserVisit(), trainingClassQuestion));
146    }
147
148    MimeType questionMimeType;
149    
150    @Override
151    public void doLock(TrainingClassQuestionEdit edit, TrainingClassQuestion trainingClassQuestion) {
152        var trainingClassQuestionTranslation = trainingControl.getTrainingClassQuestionTranslation(trainingClassQuestion, getPreferredLanguage());
153        var trainingClassQuestionDetail = trainingClassQuestion.getLastDetail();
154
155        edit.setTrainingClassQuestionName(trainingClassQuestionDetail.getTrainingClassQuestionName());
156        edit.setAskingRequired(trainingClassQuestionDetail.getAskingRequired().toString());
157        edit.setPassingRequired(trainingClassQuestionDetail.getPassingRequired().toString());
158        edit.setSortOrder(trainingClassQuestionDetail.getSortOrder().toString());
159
160        if(trainingClassQuestionTranslation != null) {
161            edit.setQuestionMimeTypeName(trainingClassQuestionTranslation.getQuestionMimeType().getLastDetail().getMimeTypeName());
162            edit.setQuestion(trainingClassQuestionTranslation.getQuestion());
163        }
164    }
165
166    @Override
167    public void canUpdate(TrainingClassQuestion trainingClassQuestion) {
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 questionMimeTypeName = edit.getQuestionMimeTypeName();
175            var question = edit.getQuestion();
176
177            questionMimeType = mimeTypeLogic.checkMimeType(this, questionMimeTypeName, question, MimeTypeUsageTypes.TEXT.name(),
178                    ExecutionErrors.MissingRequiredQuestionMimeTypeName.name(), ExecutionErrors.MissingRequiredQuestion.name(),
179                    ExecutionErrors.UnknownQuestionMimeTypeName.name(), ExecutionErrors.UnknownQuestionMimeTypeUsage.name());
180        }
181    }
182    
183    @Override
184    public void doUpdate(TrainingClassQuestion trainingClassQuestion) {
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}