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.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.Arrays; 047import java.util.Collections; 048import java.util.List; 049import javax.enterprise.context.RequestScoped; 050 051@RequestScoped 052public class EditTrainingClassAnswerTranslationCommand 053 extends BaseAbstractEditCommand<TrainingClassAnswerTranslationSpec, TrainingClassAnswerTranslationEdit, EditTrainingClassAnswerTranslationResult, TrainingClassAnswerTranslation, TrainingClassAnswer> { 054 055 private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION; 056 private final static List<FieldDefinition> SPEC_FIELD_DEFINITIONS; 057 private final static List<FieldDefinition> EDIT_FIELD_DEFINITIONS; 058 059 static { 060 COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(Collections.unmodifiableList(Arrays.asList( 061 new PartyTypeDefinition(PartyTypes.UTILITY.name(), null), 062 new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), Collections.unmodifiableList(Arrays.asList( 063 new SecurityRoleDefinition(SecurityRoleGroups.TrainingClassAnswer.name(), SecurityRoles.Translation.name()) 064 ))) 065 ))); 066 067 SPEC_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList( 068 new FieldDefinition("TrainingClassName", FieldType.ENTITY_NAME, true, null, null), 069 new FieldDefinition("TrainingClassSectionName", FieldType.ENTITY_NAME, true, null, null), 070 new FieldDefinition("TrainingClassQuestionName", FieldType.ENTITY_NAME, true, null, null), 071 new FieldDefinition("TrainingClassAnswerName", FieldType.ENTITY_NAME, true, null, null), 072 new FieldDefinition("LanguageIsoName", FieldType.ENTITY_NAME, true, null, null) 073 )); 074 075 EDIT_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList( 076 new FieldDefinition("AnswerMimeTypeName", FieldType.MIME_TYPE, true, null, null), 077 new FieldDefinition("Answer", FieldType.STRING, true, 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 EditTrainingClassAnswerTranslationCommand */ 084 public EditTrainingClassAnswerTranslationCommand() { 085 super(COMMAND_SECURITY_DEFINITION, SPEC_FIELD_DEFINITIONS, EDIT_FIELD_DEFINITIONS); 086 } 087 088 @Override 089 public EditTrainingClassAnswerTranslationResult getResult() { 090 return TrainingResultFactory.getEditTrainingClassAnswerTranslationResult(); 091 } 092 093 @Override 094 public TrainingClassAnswerTranslationEdit getEdit() { 095 return TrainingEditFactory.getTrainingClassAnswerTranslationEdit(); 096 } 097 098 TrainingClassQuestion trainingClassQuestion; 099 100 @Override 101 public TrainingClassAnswerTranslation getEntity(EditTrainingClassAnswerTranslationResult result) { 102 var trainingControl = Session.getModelController(TrainingControl.class); 103 TrainingClassAnswerTranslation trainingClassAnswerTranslation = 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 var trainingClassAnswer = trainingControl.getTrainingClassAnswerByName(trainingClassQuestion, trainingClassAnswerName); 119 120 if(trainingClassAnswer != null) { 121 var partyControl = Session.getModelController(PartyControl.class); 122 var languageIsoName = spec.getLanguageIsoName(); 123 var language = partyControl.getLanguageByIsoName(languageIsoName); 124 125 if(language != null) { 126 if(editMode.equals(EditMode.LOCK) || editMode.equals(EditMode.ABANDON)) { 127 trainingClassAnswerTranslation = trainingControl.getTrainingClassAnswerTranslation(trainingClassAnswer, language); 128 } else { // EditMode.UPDATE 129 trainingClassAnswerTranslation = trainingControl.getTrainingClassAnswerTranslationForUpdate(trainingClassAnswer, language); 130 } 131 132 if(trainingClassAnswerTranslation == null) { 133 addExecutionError(ExecutionErrors.UnknownTrainingClassAnswerTranslation.name(), trainingClassName, trainingClassSectionName, 134 trainingClassQuestionName, trainingClassAnswerName, languageIsoName); 135 } 136 } else { 137 addExecutionError(ExecutionErrors.UnknownLanguageIsoName.name(), languageIsoName); 138 } 139 } else { 140 addExecutionError(ExecutionErrors.UnknownTrainingClassAnswerName.name(), trainingClassName, trainingClassSectionName, 141 trainingClassQuestionName, trainingClassAnswerName); 142 } 143 } else { 144 addExecutionError(ExecutionErrors.UnknownTrainingClassQuestionName.name(), trainingClassName, trainingClassSectionName, 145 trainingClassQuestionName); 146 } 147 } else { 148 addExecutionError(ExecutionErrors.UnknownTrainingClassSectionName.name(), trainingClassName, trainingClassSectionName); 149 } 150 } else { 151 addExecutionError(ExecutionErrors.UnknownTrainingClassName.name(), trainingClassName); 152 } 153 154 return trainingClassAnswerTranslation; 155 } 156 157 @Override 158 public TrainingClassAnswer getLockEntity(TrainingClassAnswerTranslation trainingClassAnswerTranslation) { 159 return trainingClassAnswerTranslation.getTrainingClassAnswer(); 160 } 161 162 @Override 163 public void fillInResult(EditTrainingClassAnswerTranslationResult result, TrainingClassAnswerTranslation trainingClassAnswerTranslation) { 164 var trainingControl = Session.getModelController(TrainingControl.class); 165 166 result.setTrainingClassAnswerTranslation(trainingControl.getTrainingClassAnswerTranslationTransfer(getUserVisit(), trainingClassAnswerTranslation)); 167 } 168 169 MimeType answerMimeType; 170 MimeType selectedMimeType; 171 172 @Override 173 public void doLock(TrainingClassAnswerTranslationEdit edit, TrainingClassAnswerTranslation trainingClassAnswerTranslation) { 174 answerMimeType = trainingClassAnswerTranslation.getAnswerMimeType(); 175 selectedMimeType = trainingClassAnswerTranslation.getSelectedMimeType(); 176 177 edit.setAnswerMimeTypeName(answerMimeType == null? null: answerMimeType.getLastDetail().getMimeTypeName()); 178 edit.setAnswer(trainingClassAnswerTranslation.getAnswer()); 179 edit.setSelectedMimeTypeName(selectedMimeType == null? null: selectedMimeType.getLastDetail().getMimeTypeName()); 180 edit.setSelected(trainingClassAnswerTranslation.getSelected()); 181 } 182 183 @Override 184 protected void canUpdate(TrainingClassAnswerTranslation trainingClassAnswerTranslation) { 185 var mimeTypeLogic = MimeTypeLogic.getInstance(); 186 var answerMimeTypeName = edit.getAnswerMimeTypeName(); 187 var answer = edit.getAnswer(); 188 189 answerMimeType = mimeTypeLogic.checkMimeType(this, answerMimeTypeName, answer, MimeTypeUsageTypes.TEXT.name(), 190 ExecutionErrors.MissingRequiredAnswerMimeTypeName.name(), ExecutionErrors.MissingRequiredAnswer.name(), 191 ExecutionErrors.UnknownAnswerMimeTypeName.name(), ExecutionErrors.UnknownAnswerMimeTypeUsage.name()); 192 193 if(!hasExecutionErrors()) { 194 var selectedMimeTypeName = edit.getSelectedMimeTypeName(); 195 var selected = edit.getSelected(); 196 197 selectedMimeType = mimeTypeLogic.checkMimeType(this, selectedMimeTypeName, selected, MimeTypeUsageTypes.TEXT.name(), 198 ExecutionErrors.MissingRequiredSelectedMimeTypeName.name(), ExecutionErrors.MissingRequiredSelected.name(), 199 ExecutionErrors.UnknownSelectedMimeTypeName.name(), ExecutionErrors.UnknownSelectedMimeTypeUsage.name()); 200 } 201 } 202 203 @Override 204 public void doUpdate(TrainingClassAnswerTranslation trainingClassAnswerTranslation) { 205 var trainingControl = Session.getModelController(TrainingControl.class); 206 var trainingClassAnswerTranslationValue = trainingControl.getTrainingClassAnswerTranslationValue(trainingClassAnswerTranslation); 207 208 trainingClassAnswerTranslationValue.setAnswerMimeTypePK(answerMimeType == null? null: answerMimeType.getPrimaryKey()); 209 trainingClassAnswerTranslationValue.setAnswer(edit.getAnswer()); 210 trainingClassAnswerTranslationValue.setSelectedMimeTypePK(selectedMimeType == null? null: selectedMimeType.getPrimaryKey()); 211 trainingClassAnswerTranslationValue.setSelected(edit.getSelected()); 212 213 trainingControl.updateTrainingClassAnswerTranslationFromValue(trainingClassAnswerTranslationValue, getPartyPK()); 214 } 215 216}