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