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.TrainingClassAnswerEdit; 020import com.echothree.control.user.training.common.edit.TrainingEditFactory; 021import com.echothree.control.user.training.common.form.EditTrainingClassAnswerForm; 022import com.echothree.control.user.training.common.result.EditTrainingClassAnswerResult; 023import com.echothree.control.user.training.common.result.TrainingResultFactory; 024import com.echothree.control.user.training.common.spec.TrainingClassAnswerSpec; 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.TrainingClassAnswer; 033import com.echothree.model.data.training.server.entity.TrainingClassQuestion; 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 EditTrainingClassAnswerCommand 049 extends BaseAbstractEditCommand<TrainingClassAnswerSpec, TrainingClassAnswerEdit, EditTrainingClassAnswerResult, TrainingClassAnswer, TrainingClassAnswer> { 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.TrainingClassAnswer.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 new FieldDefinition("TrainingClassAnswerName", FieldType.ENTITY_NAME, true, null, null) 068 ); 069 070 EDIT_FIELD_DEFINITIONS = List.of( 071 new FieldDefinition("TrainingClassAnswerName", FieldType.ENTITY_NAME, true, null, null), 072 new FieldDefinition("IsCorrect", FieldType.BOOLEAN, true, null, null), 073 new FieldDefinition("SortOrder", FieldType.SIGNED_INTEGER, true, null, null), 074 new FieldDefinition("AnswerMimeTypeName", FieldType.MIME_TYPE, false, null, null), 075 new FieldDefinition("Answer", FieldType.STRING, false, null, null), 076 new FieldDefinition("SelectedMimeTypeName", FieldType.MIME_TYPE, false, null, null), 077 new FieldDefinition("Selected", FieldType.STRING, false, null, null) 078 ); 079 } 080 081 @Inject 082 TrainingControl trainingControl; 083 084 @Inject 085 MimeTypeLogic mimeTypeLogic; 086 087 088 /** Creates a new instance of EditTrainingClassAnswerCommand */ 089 public EditTrainingClassAnswerCommand() { 090 super(COMMAND_SECURITY_DEFINITION, SPEC_FIELD_DEFINITIONS, EDIT_FIELD_DEFINITIONS); 091 } 092 093 @Override 094 public EditTrainingClassAnswerResult getResult() { 095 return TrainingResultFactory.getEditTrainingClassAnswerResult(); 096 } 097 098 @Override 099 public TrainingClassAnswerEdit getEdit() { 100 return TrainingEditFactory.getTrainingClassAnswerEdit(); 101 } 102 103 TrainingClassQuestion trainingClassQuestion; 104 105 @Override 106 public TrainingClassAnswer getEntity(EditTrainingClassAnswerResult result) { 107 TrainingClassAnswer trainingClassAnswer = null; 108 var trainingClassName = spec.getTrainingClassName(); 109 var trainingClass = trainingControl.getTrainingClassByName(trainingClassName); 110 111 if(trainingClass != null) { 112 var trainingClassSectionName = spec.getTrainingClassSectionName(); 113 var trainingClassSection = trainingControl.getTrainingClassSectionByName(trainingClass, trainingClassSectionName); 114 115 if(trainingClassSection != null) { 116 var trainingClassQuestionName = spec.getTrainingClassQuestionName(); 117 118 trainingClassQuestion = trainingControl.getTrainingClassQuestionByName(trainingClassSection, trainingClassQuestionName); 119 120 if(trainingClassQuestion != null) { 121 var trainingClassAnswerName = spec.getTrainingClassAnswerName(); 122 123 if(editMode.equals(EditMode.LOCK) || editMode.equals(EditMode.ABANDON)) { 124 trainingClassAnswer = trainingControl.getTrainingClassAnswerByName(trainingClassQuestion, trainingClassAnswerName); 125 } else { // EditMode.UPDATE 126 trainingClassAnswer = trainingControl.getTrainingClassAnswerByNameForUpdate(trainingClassQuestion, trainingClassAnswerName); 127 } 128 129 if(trainingClassAnswer != null) { 130 result.setTrainingClassAnswer(trainingControl.getTrainingClassAnswerTransfer(getUserVisit(), trainingClassAnswer)); 131 } else { 132 addExecutionError(ExecutionErrors.UnknownTrainingClassAnswerName.name(), trainingClassName, trainingClassSectionName, 133 trainingClassQuestionName, trainingClassAnswerName); 134 } 135 } else { 136 addExecutionError(ExecutionErrors.UnknownTrainingClassQuestionName.name(), trainingClassName, trainingClassSectionName, 137 trainingClassQuestionName); 138 } 139 } else { 140 addExecutionError(ExecutionErrors.UnknownTrainingClassSectionName.name(), trainingClassName, trainingClassSectionName); 141 } 142 } else { 143 addExecutionError(ExecutionErrors.UnknownTrainingClassName.name(), trainingClassName); 144 } 145 146 return trainingClassAnswer; 147 } 148 149 @Override 150 public TrainingClassAnswer getLockEntity(TrainingClassAnswer trainingClassAnswer) { 151 return trainingClassAnswer; 152 } 153 154 @Override 155 public void fillInResult(EditTrainingClassAnswerResult result, TrainingClassAnswer trainingClassAnswer) { 156 result.setTrainingClassAnswer(trainingControl.getTrainingClassAnswerTransfer(getUserVisit(), trainingClassAnswer)); 157 } 158 159 MimeType answerMimeType; 160 MimeType selectedMimeType; 161 162 @Override 163 public void doLock(TrainingClassAnswerEdit edit, TrainingClassAnswer trainingClassAnswer) { 164 var trainingClassAnswerTranslation = trainingControl.getTrainingClassAnswerTranslation(trainingClassAnswer, getPreferredLanguage()); 165 var trainingClassAnswerDetail = trainingClassAnswer.getLastDetail(); 166 167 edit.setTrainingClassAnswerName(trainingClassAnswerDetail.getTrainingClassAnswerName()); 168 edit.setIsCorrect(trainingClassAnswerDetail.getIsCorrect().toString()); 169 edit.setSortOrder(trainingClassAnswerDetail.getSortOrder().toString()); 170 171 if(trainingClassAnswerTranslation != null) { 172 answerMimeType = trainingClassAnswerTranslation.getAnswerMimeType(); 173 selectedMimeType = trainingClassAnswerTranslation.getSelectedMimeType(); 174 175 edit.setAnswerMimeTypeName(answerMimeType == null? null: answerMimeType.getLastDetail().getMimeTypeName()); 176 edit.setAnswer(trainingClassAnswerTranslation.getAnswer()); 177 edit.setSelectedMimeTypeName(selectedMimeType == null? null: selectedMimeType.getLastDetail().getMimeTypeName()); 178 edit.setSelected(trainingClassAnswerTranslation.getSelected()); 179 } 180 } 181 182 @Override 183 public void canUpdate(TrainingClassAnswer trainingClassAnswer) { 184 var trainingClassAnswerName = edit.getTrainingClassAnswerName(); 185 var duplicateTrainingClassAnswer = trainingControl.getTrainingClassAnswerByName(trainingClassQuestion, trainingClassAnswerName); 186 187 if(duplicateTrainingClassAnswer != null && !trainingClassAnswer.equals(duplicateTrainingClassAnswer)) { 188 addExecutionError(ExecutionErrors.DuplicateTrainingClassAnswerName.name(), trainingClassAnswerName); 189 } else { 190 var answerMimeTypeName = edit.getAnswerMimeTypeName(); 191 var answer = edit.getAnswer(); 192 193 answerMimeType = mimeTypeLogic.checkMimeType(this, answerMimeTypeName, answer, MimeTypeUsageTypes.TEXT.name(), 194 ExecutionErrors.MissingRequiredAnswerMimeTypeName.name(), ExecutionErrors.MissingRequiredAnswer.name(), 195 ExecutionErrors.UnknownAnswerMimeTypeName.name(), ExecutionErrors.UnknownAnswerMimeTypeUsage.name()); 196 197 if(!hasExecutionErrors()) { 198 var selected = edit.getSelected(); 199 200 selectedMimeType = mimeTypeLogic.checkMimeType(this, edit.getSelectedMimeTypeName(), selected, MimeTypeUsageTypes.TEXT.name(), 201 ExecutionErrors.MissingRequiredSelectedMimeTypeName.name(), ExecutionErrors.MissingRequiredSelected.name(), 202 ExecutionErrors.UnknownSelectedMimeTypeName.name(), ExecutionErrors.UnknownSelectedMimeTypeUsage.name()); 203 204 if(!hasExecutionErrors()) { 205 if(answer == null && selected != null) { 206 addExecutionError(ExecutionErrors.MissingRequiredAnswerMimeTypeName.name()); 207 addExecutionError(ExecutionErrors.MissingRequiredAnswer.name()); 208 } 209 } 210 } 211 } 212 } 213 214 @Override 215 public void doUpdate(TrainingClassAnswer trainingClassAnswer) { 216 var partyPK = getPartyPK(); 217 var trainingClassAnswerDetailValue = trainingControl.getTrainingClassAnswerDetailValueForUpdate(trainingClassAnswer); 218 var trainingClassAnswerTranslation = trainingControl.getTrainingClassAnswerTranslationForUpdate(trainingClassAnswer, getPreferredLanguage()); 219 var answer = edit.getAnswer(); 220 var selected = edit.getSelected(); 221 222 trainingClassAnswerDetailValue.setTrainingClassAnswerName(edit.getTrainingClassAnswerName()); 223 trainingClassAnswerDetailValue.setIsCorrect(Boolean.valueOf(edit.getIsCorrect())); 224 trainingClassAnswerDetailValue.setSortOrder(Integer.valueOf(edit.getSortOrder())); 225 226 trainingControl.updateTrainingClassAnswerFromValue(trainingClassAnswerDetailValue, partyPK); 227 228 if(trainingClassAnswerTranslation == null && (answer != null || selected != null)) { 229 trainingControl.createTrainingClassAnswerTranslation(trainingClassAnswer, getPreferredLanguage(), answerMimeType, answer, selectedMimeType, 230 selected, partyPK); 231 } else if(trainingClassAnswerTranslation != null && (answer == null && selected == null)) { 232 trainingControl.deleteTrainingClassAnswerTranslation(trainingClassAnswerTranslation, partyPK); 233 } else if(trainingClassAnswerTranslation != null && (answer != null || selected != null)) { 234 var trainingClassAnswerTranslationValue = trainingControl.getTrainingClassAnswerTranslationValue(trainingClassAnswerTranslation); 235 236 trainingClassAnswerTranslationValue.setAnswerMimeTypePK(answerMimeType == null? null: answerMimeType.getPrimaryKey()); 237 trainingClassAnswerTranslationValue.setAnswer(answer); 238 trainingClassAnswerTranslationValue.setSelectedMimeTypePK(selectedMimeType == null? null: selectedMimeType.getPrimaryKey()); 239 trainingClassAnswerTranslationValue.setSelected(selected); 240 trainingControl.updateTrainingClassAnswerTranslationFromValue(trainingClassAnswerTranslationValue, partyPK); 241 } 242 } 243 244}