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.TrainingClassAnswerTranslationEdit; 020import com.echothree.control.user.training.common.edit.TrainingEditFactory; 021import com.echothree.control.user.training.common.form.EditTrainingClassAnswerTranslationForm; 022import com.echothree.control.user.training.common.result.EditTrainingClassAnswerTranslationResult; 023import com.echothree.control.user.training.common.result.TrainingResultFactory; 024import com.echothree.control.user.training.common.spec.TrainingClassAnswerTranslationSpec; 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.party.server.control.PartyControl; 029import com.echothree.model.control.security.common.SecurityRoleGroups; 030import com.echothree.model.control.security.common.SecurityRoles; 031import com.echothree.model.control.training.server.control.TrainingControl; 032import com.echothree.model.data.core.server.entity.MimeType; 033import com.echothree.model.data.training.server.entity.TrainingClassAnswer; 034import com.echothree.model.data.training.server.entity.TrainingClassAnswerTranslation; 035import com.echothree.model.data.training.server.entity.TrainingClassQuestion; 036import com.echothree.model.data.user.common.pk.UserVisitPK; 037import com.echothree.util.common.message.ExecutionErrors; 038import com.echothree.util.common.validation.FieldDefinition; 039import com.echothree.util.common.validation.FieldType; 040import com.echothree.util.common.command.EditMode; 041import com.echothree.util.server.control.BaseAbstractEditCommand; 042import com.echothree.util.server.control.CommandSecurityDefinition; 043import com.echothree.util.server.control.PartyTypeDefinition; 044import com.echothree.util.server.control.SecurityRoleDefinition; 045import com.echothree.util.server.persistence.Session; 046import java.util.List; 047import javax.enterprise.context.Dependent; 048 049@Dependent 050public class EditTrainingClassAnswerTranslationCommand 051 extends BaseAbstractEditCommand<TrainingClassAnswerTranslationSpec, TrainingClassAnswerTranslationEdit, EditTrainingClassAnswerTranslationResult, TrainingClassAnswerTranslation, 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(List.of( 059 new PartyTypeDefinition(PartyTypes.UTILITY.name(), null), 060 new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of( 061 new SecurityRoleDefinition(SecurityRoleGroups.TrainingClassAnswer.name(), SecurityRoles.Translation.name()) 062 )) 063 )); 064 065 SPEC_FIELD_DEFINITIONS = List.of( 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 new FieldDefinition("LanguageIsoName", FieldType.ENTITY_NAME, true, null, null) 071 ); 072 073 EDIT_FIELD_DEFINITIONS = List.of( 074 new FieldDefinition("AnswerMimeTypeName", FieldType.MIME_TYPE, true, null, null), 075 new FieldDefinition("Answer", FieldType.STRING, true, 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 /** Creates a new instance of EditTrainingClassAnswerTranslationCommand */ 082 public EditTrainingClassAnswerTranslationCommand() { 083 super(COMMAND_SECURITY_DEFINITION, SPEC_FIELD_DEFINITIONS, EDIT_FIELD_DEFINITIONS); 084 } 085 086 @Override 087 public EditTrainingClassAnswerTranslationResult getResult() { 088 return TrainingResultFactory.getEditTrainingClassAnswerTranslationResult(); 089 } 090 091 @Override 092 public TrainingClassAnswerTranslationEdit getEdit() { 093 return TrainingEditFactory.getTrainingClassAnswerTranslationEdit(); 094 } 095 096 TrainingClassQuestion trainingClassQuestion; 097 098 @Override 099 public TrainingClassAnswerTranslation getEntity(EditTrainingClassAnswerTranslationResult result) { 100 var trainingControl = Session.getModelController(TrainingControl.class); 101 TrainingClassAnswerTranslation trainingClassAnswerTranslation = null; 102 var trainingClassName = spec.getTrainingClassName(); 103 var trainingClass = trainingControl.getTrainingClassByName(trainingClassName); 104 105 if(trainingClass != null) { 106 var trainingClassSectionName = spec.getTrainingClassSectionName(); 107 var trainingClassSection = trainingControl.getTrainingClassSectionByName(trainingClass, trainingClassSectionName); 108 109 if(trainingClassSection != null) { 110 var trainingClassQuestionName = spec.getTrainingClassQuestionName(); 111 112 trainingClassQuestion = trainingControl.getTrainingClassQuestionByName(trainingClassSection, trainingClassQuestionName); 113 114 if(trainingClassQuestion != null) { 115 var trainingClassAnswerName = spec.getTrainingClassAnswerName(); 116 var trainingClassAnswer = trainingControl.getTrainingClassAnswerByName(trainingClassQuestion, trainingClassAnswerName); 117 118 if(trainingClassAnswer != null) { 119 var partyControl = Session.getModelController(PartyControl.class); 120 var languageIsoName = spec.getLanguageIsoName(); 121 var language = partyControl.getLanguageByIsoName(languageIsoName); 122 123 if(language != null) { 124 if(editMode.equals(EditMode.LOCK) || editMode.equals(EditMode.ABANDON)) { 125 trainingClassAnswerTranslation = trainingControl.getTrainingClassAnswerTranslation(trainingClassAnswer, language); 126 } else { // EditMode.UPDATE 127 trainingClassAnswerTranslation = trainingControl.getTrainingClassAnswerTranslationForUpdate(trainingClassAnswer, language); 128 } 129 130 if(trainingClassAnswerTranslation == null) { 131 addExecutionError(ExecutionErrors.UnknownTrainingClassAnswerTranslation.name(), trainingClassName, trainingClassSectionName, 132 trainingClassQuestionName, trainingClassAnswerName, languageIsoName); 133 } 134 } else { 135 addExecutionError(ExecutionErrors.UnknownLanguageIsoName.name(), languageIsoName); 136 } 137 } else { 138 addExecutionError(ExecutionErrors.UnknownTrainingClassAnswerName.name(), trainingClassName, trainingClassSectionName, 139 trainingClassQuestionName, trainingClassAnswerName); 140 } 141 } else { 142 addExecutionError(ExecutionErrors.UnknownTrainingClassQuestionName.name(), trainingClassName, trainingClassSectionName, 143 trainingClassQuestionName); 144 } 145 } else { 146 addExecutionError(ExecutionErrors.UnknownTrainingClassSectionName.name(), trainingClassName, trainingClassSectionName); 147 } 148 } else { 149 addExecutionError(ExecutionErrors.UnknownTrainingClassName.name(), trainingClassName); 150 } 151 152 return trainingClassAnswerTranslation; 153 } 154 155 @Override 156 public TrainingClassAnswer getLockEntity(TrainingClassAnswerTranslation trainingClassAnswerTranslation) { 157 return trainingClassAnswerTranslation.getTrainingClassAnswer(); 158 } 159 160 @Override 161 public void fillInResult(EditTrainingClassAnswerTranslationResult result, TrainingClassAnswerTranslation trainingClassAnswerTranslation) { 162 var trainingControl = Session.getModelController(TrainingControl.class); 163 164 result.setTrainingClassAnswerTranslation(trainingControl.getTrainingClassAnswerTranslationTransfer(getUserVisit(), trainingClassAnswerTranslation)); 165 } 166 167 MimeType answerMimeType; 168 MimeType selectedMimeType; 169 170 @Override 171 public void doLock(TrainingClassAnswerTranslationEdit edit, TrainingClassAnswerTranslation trainingClassAnswerTranslation) { 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 @Override 182 protected void canUpdate(TrainingClassAnswerTranslation trainingClassAnswerTranslation) { 183 var mimeTypeLogic = MimeTypeLogic.getInstance(); 184 var answerMimeTypeName = edit.getAnswerMimeTypeName(); 185 var answer = edit.getAnswer(); 186 187 answerMimeType = mimeTypeLogic.checkMimeType(this, answerMimeTypeName, answer, MimeTypeUsageTypes.TEXT.name(), 188 ExecutionErrors.MissingRequiredAnswerMimeTypeName.name(), ExecutionErrors.MissingRequiredAnswer.name(), 189 ExecutionErrors.UnknownAnswerMimeTypeName.name(), ExecutionErrors.UnknownAnswerMimeTypeUsage.name()); 190 191 if(!hasExecutionErrors()) { 192 var selectedMimeTypeName = edit.getSelectedMimeTypeName(); 193 var selected = edit.getSelected(); 194 195 selectedMimeType = mimeTypeLogic.checkMimeType(this, selectedMimeTypeName, selected, MimeTypeUsageTypes.TEXT.name(), 196 ExecutionErrors.MissingRequiredSelectedMimeTypeName.name(), ExecutionErrors.MissingRequiredSelected.name(), 197 ExecutionErrors.UnknownSelectedMimeTypeName.name(), ExecutionErrors.UnknownSelectedMimeTypeUsage.name()); 198 } 199 } 200 201 @Override 202 public void doUpdate(TrainingClassAnswerTranslation trainingClassAnswerTranslation) { 203 var trainingControl = Session.getModelController(TrainingControl.class); 204 var trainingClassAnswerTranslationValue = trainingControl.getTrainingClassAnswerTranslationValue(trainingClassAnswerTranslation); 205 206 trainingClassAnswerTranslationValue.setAnswerMimeTypePK(answerMimeType == null? null: answerMimeType.getPrimaryKey()); 207 trainingClassAnswerTranslationValue.setAnswer(edit.getAnswer()); 208 trainingClassAnswerTranslationValue.setSelectedMimeTypePK(selectedMimeType == null? null: selectedMimeType.getPrimaryKey()); 209 trainingClassAnswerTranslationValue.setSelected(edit.getSelected()); 210 211 trainingControl.updateTrainingClassAnswerTranslationFromValue(trainingClassAnswerTranslationValue, getPartyPK()); 212 } 213 214}