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.item.server.command; 018 019import com.echothree.control.user.item.common.edit.HarmonizedTariffScheduleCodeEdit; 020import com.echothree.control.user.item.common.edit.ItemEditFactory; 021import com.echothree.control.user.item.common.form.EditHarmonizedTariffScheduleCodeForm; 022import com.echothree.control.user.item.common.result.EditHarmonizedTariffScheduleCodeResult; 023import com.echothree.control.user.item.common.result.ItemResultFactory; 024import com.echothree.control.user.item.common.spec.HarmonizedTariffScheduleCodeSpec; 025import com.echothree.model.control.core.common.MimeTypeUsageTypes; 026import com.echothree.model.control.core.server.logic.MimeTypeLogic; 027import com.echothree.model.control.geo.server.control.GeoControl; 028import com.echothree.model.control.item.server.control.ItemControl; 029import com.echothree.model.control.party.common.PartyTypes; 030import com.echothree.model.control.security.common.SecurityRoleGroups; 031import com.echothree.model.control.security.common.SecurityRoles; 032import com.echothree.model.data.core.server.entity.MimeType; 033import com.echothree.model.data.geo.server.entity.GeoCode; 034import com.echothree.model.data.item.server.entity.HarmonizedTariffScheduleCode; 035import com.echothree.model.data.item.server.entity.HarmonizedTariffScheduleCodeUnit; 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 EditHarmonizedTariffScheduleCodeCommand 051 extends BaseAbstractEditCommand<HarmonizedTariffScheduleCodeSpec, HarmonizedTariffScheduleCodeEdit, EditHarmonizedTariffScheduleCodeResult, HarmonizedTariffScheduleCode, HarmonizedTariffScheduleCode> { 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.HarmonizedTariffScheduleCode.name(), SecurityRoles.Edit.name()) 062 )) 063 )); 064 065 SPEC_FIELD_DEFINITIONS = List.of( 066 new FieldDefinition("CountryName", FieldType.ENTITY_NAME, true, null, null), 067 new FieldDefinition("HarmonizedTariffScheduleCodeName", FieldType.ENTITY_NAME, true, null, null) 068 ); 069 070 EDIT_FIELD_DEFINITIONS = List.of( 071 new FieldDefinition("HarmonizedTariffScheduleCodeName", FieldType.ENTITY_NAME, true, null, null), 072 new FieldDefinition("FirstHarmonizedTariffScheduleCodeUnitName", FieldType.ENTITY_NAME, false, null, null), 073 new FieldDefinition("SecondHarmonizedTariffScheduleCodeUnitName", FieldType.ENTITY_NAME, false, null, null), 074 new FieldDefinition("IsDefault", FieldType.BOOLEAN, true, null, null), 075 new FieldDefinition("SortOrder", FieldType.SIGNED_INTEGER, true, null, null), 076 new FieldDefinition("Description", FieldType.STRING, false, 1L, 132L), 077 new FieldDefinition("OverviewMimeTypeName", FieldType.MIME_TYPE, false, null, null), 078 new FieldDefinition("Overview", FieldType.STRING, false, null, null) 079 ); 080 } 081 082 /** Creates a new instance of EditHarmonizedTariffScheduleCodeCommand */ 083 public EditHarmonizedTariffScheduleCodeCommand() { 084 super(COMMAND_SECURITY_DEFINITION, SPEC_FIELD_DEFINITIONS, EDIT_FIELD_DEFINITIONS); 085 } 086 087 @Override 088 public EditHarmonizedTariffScheduleCodeResult getResult() { 089 return ItemResultFactory.getEditHarmonizedTariffScheduleCodeResult(); 090 } 091 092 @Override 093 public HarmonizedTariffScheduleCodeEdit getEdit() { 094 return ItemEditFactory.getHarmonizedTariffScheduleCodeEdit(); 095 } 096 097 GeoCode countryGeoCode; 098 099 @Override 100 public HarmonizedTariffScheduleCode getEntity(EditHarmonizedTariffScheduleCodeResult result) { 101 var geoControl = Session.getModelController(GeoControl.class); 102 HarmonizedTariffScheduleCode harmonizedTariffScheduleCode = null; 103 var countryName = spec.getCountryName(); 104 105 countryGeoCode = geoControl.getCountryByAlias(countryName); 106 107 if(countryGeoCode != null) { 108 var itemControl = Session.getModelController(ItemControl.class); 109 var harmonizedTariffScheduleCodeName = spec.getHarmonizedTariffScheduleCodeName(); 110 111 if(editMode.equals(EditMode.LOCK) || editMode.equals(EditMode.ABANDON)) { 112 harmonizedTariffScheduleCode = itemControl.getHarmonizedTariffScheduleCodeByName(countryGeoCode, harmonizedTariffScheduleCodeName); 113 } else { // EditMode.UPDATE 114 harmonizedTariffScheduleCode = itemControl.getHarmonizedTariffScheduleCodeByNameForUpdate(countryGeoCode, harmonizedTariffScheduleCodeName); 115 } 116 117 if(harmonizedTariffScheduleCode == null) { 118 addExecutionError(ExecutionErrors.UnknownHarmonizedTariffScheduleCodeName.name(), countryName, harmonizedTariffScheduleCodeName); 119 } 120 } else { 121 addExecutionError(ExecutionErrors.UnknownGeoCodeName.name(), countryName); 122 } 123 124 return harmonizedTariffScheduleCode; 125 } 126 127 @Override 128 public HarmonizedTariffScheduleCode getLockEntity(HarmonizedTariffScheduleCode harmonizedTariffScheduleCode) { 129 return harmonizedTariffScheduleCode; 130 } 131 132 @Override 133 public void fillInResult(EditHarmonizedTariffScheduleCodeResult result, HarmonizedTariffScheduleCode harmonizedTariffScheduleCode) { 134 var itemControl = Session.getModelController(ItemControl.class); 135 136 result.setHarmonizedTariffScheduleCode(itemControl.getHarmonizedTariffScheduleCodeTransfer(getUserVisit(), harmonizedTariffScheduleCode)); 137 } 138 139 MimeType overviewMimeType; 140 141 HarmonizedTariffScheduleCodeUnit firstHarmonizedTariffScheduleCodeUnit; 142 HarmonizedTariffScheduleCodeUnit secondHarmonizedTariffScheduleCodeUnit; 143 144 @Override 145 public void doLock(HarmonizedTariffScheduleCodeEdit edit, HarmonizedTariffScheduleCode harmonizedTariffScheduleCode) { 146 var itemControl = Session.getModelController(ItemControl.class); 147 var harmonizedTariffScheduleCodeTranslation = itemControl.getHarmonizedTariffScheduleCodeTranslation(harmonizedTariffScheduleCode, getPreferredLanguage()); 148 var harmonizedTariffScheduleCodeDetail = harmonizedTariffScheduleCode.getLastDetail(); 149 150 firstHarmonizedTariffScheduleCodeUnit = harmonizedTariffScheduleCodeDetail.getFirstHarmonizedTariffScheduleCodeUnit(); 151 secondHarmonizedTariffScheduleCodeUnit = harmonizedTariffScheduleCodeDetail.getSecondHarmonizedTariffScheduleCodeUnit(); 152 153 edit.setHarmonizedTariffScheduleCodeName(harmonizedTariffScheduleCodeDetail.getHarmonizedTariffScheduleCodeName()); 154 edit.setFirstHarmonizedTariffScheduleCodeUnitName(firstHarmonizedTariffScheduleCodeUnit == null ? null : firstHarmonizedTariffScheduleCodeUnit.getLastDetail().getHarmonizedTariffScheduleCodeUnitName()); 155 edit.setSecondHarmonizedTariffScheduleCodeUnitName(secondHarmonizedTariffScheduleCodeUnit == null ? null : secondHarmonizedTariffScheduleCodeUnit.getLastDetail().getHarmonizedTariffScheduleCodeUnitName()); 156 edit.setIsDefault(harmonizedTariffScheduleCodeDetail.getIsDefault().toString()); 157 edit.setSortOrder(harmonizedTariffScheduleCodeDetail.getSortOrder().toString()); 158 159 if(harmonizedTariffScheduleCodeTranslation != null) { 160 overviewMimeType = harmonizedTariffScheduleCodeTranslation.getOverviewMimeType(); 161 162 edit.setDescription(harmonizedTariffScheduleCodeTranslation.getDescription()); 163 edit.setOverviewMimeTypeName(overviewMimeType == null? null: overviewMimeType.getLastDetail().getMimeTypeName()); 164 edit.setOverview(harmonizedTariffScheduleCodeTranslation.getOverview()); 165 } 166 } 167 168 @Override 169 public void canUpdate(HarmonizedTariffScheduleCode harmonizedTariffScheduleCode) { 170 var itemControl = Session.getModelController(ItemControl.class); 171 var geoCodeDetail = countryGeoCode.getLastDetail(); 172 var harmonizedTariffScheduleCodeName = edit.getHarmonizedTariffScheduleCodeName(); 173 var duplicateHarmonizedTariffScheduleCode = itemControl.getHarmonizedTariffScheduleCodeByName(countryGeoCode, harmonizedTariffScheduleCodeName); 174 175 if(duplicateHarmonizedTariffScheduleCode != null && !harmonizedTariffScheduleCode.equals(duplicateHarmonizedTariffScheduleCode)) { 176 addExecutionError(ExecutionErrors.DuplicateHarmonizedTariffScheduleCodeName.name(), geoCodeDetail.getGeoCodeName(), harmonizedTariffScheduleCodeName); 177 } else { 178 var overviewMimeTypeName = edit.getOverviewMimeTypeName(); 179 var overview = edit.getOverview(); 180 181 overviewMimeType = MimeTypeLogic.getInstance().checkMimeType(this, overviewMimeTypeName, overview, MimeTypeUsageTypes.TEXT.name(), 182 ExecutionErrors.MissingRequiredOverviewMimeTypeName.name(), ExecutionErrors.MissingRequiredOverview.name(), 183 ExecutionErrors.UnknownOverviewMimeTypeName.name(), ExecutionErrors.UnknownOverviewMimeTypeUsage.name()); 184 185 if(!hasExecutionErrors()) { 186 var firstHarmonizedTariffScheduleCodeUnitName = edit.getFirstHarmonizedTariffScheduleCodeUnitName(); 187 188 firstHarmonizedTariffScheduleCodeUnit = firstHarmonizedTariffScheduleCodeUnitName == null ? null : itemControl.getHarmonizedTariffScheduleCodeUnitByName(firstHarmonizedTariffScheduleCodeUnitName); 189 190 if(firstHarmonizedTariffScheduleCodeUnitName == null || firstHarmonizedTariffScheduleCodeUnit != null) { 191 var secondHarmonizedTariffScheduleCodeUnitName = edit.getSecondHarmonizedTariffScheduleCodeUnitName(); 192 193 secondHarmonizedTariffScheduleCodeUnit = secondHarmonizedTariffScheduleCodeUnitName == null ? null : itemControl.getHarmonizedTariffScheduleCodeUnitByName(secondHarmonizedTariffScheduleCodeUnitName); 194 195 if(secondHarmonizedTariffScheduleCodeUnitName != null && secondHarmonizedTariffScheduleCodeUnit == null) { 196 addExecutionError(ExecutionErrors.UnknownSecondHarmonizedTariffScheduleCodeUnitName.name(), secondHarmonizedTariffScheduleCodeUnitName); 197 } 198 } else { 199 addExecutionError(ExecutionErrors.UnknownFirstHarmonizedTariffScheduleCodeUnitName.name(), firstHarmonizedTariffScheduleCodeUnitName); 200 } 201 } 202 } 203 } 204 205 @Override 206 public void doUpdate(HarmonizedTariffScheduleCode harmonizedTariffScheduleCode) { 207 var itemControl = Session.getModelController(ItemControl.class); 208 var partyPK = getPartyPK(); 209 var harmonizedTariffScheduleCodeDetailValue = itemControl.getHarmonizedTariffScheduleCodeDetailValueForUpdate(harmonizedTariffScheduleCode); 210 var harmonizedTariffScheduleCodeTranslation = itemControl.getHarmonizedTariffScheduleCodeTranslationForUpdate(harmonizedTariffScheduleCode, getPreferredLanguage()); 211 var description = edit.getDescription(); 212 var overview = edit.getOverview(); 213 214 harmonizedTariffScheduleCodeDetailValue.setHarmonizedTariffScheduleCodeName(edit.getHarmonizedTariffScheduleCodeName()); 215 harmonizedTariffScheduleCodeDetailValue.setFirstHarmonizedTariffScheduleCodeUnitPK(firstHarmonizedTariffScheduleCodeUnit == null ? null : firstHarmonizedTariffScheduleCodeUnit.getPrimaryKey()); 216 harmonizedTariffScheduleCodeDetailValue.setSecondHarmonizedTariffScheduleCodeUnitPK(secondHarmonizedTariffScheduleCodeUnit == null ? null : secondHarmonizedTariffScheduleCodeUnit.getPrimaryKey()); 217 harmonizedTariffScheduleCodeDetailValue.setIsDefault(Boolean.valueOf(edit.getIsDefault())); 218 harmonizedTariffScheduleCodeDetailValue.setSortOrder(Integer.valueOf(edit.getSortOrder())); 219 220 itemControl.updateHarmonizedTariffScheduleCodeFromValue(harmonizedTariffScheduleCodeDetailValue, partyPK); 221 222 if(harmonizedTariffScheduleCodeTranslation == null && (description != null || overview != null)) { 223 itemControl.createHarmonizedTariffScheduleCodeTranslation(harmonizedTariffScheduleCode, getPreferredLanguage(), description, overviewMimeType, overview, partyPK); 224 } else if(harmonizedTariffScheduleCodeTranslation != null && (description == null && overview == null)) { 225 itemControl.deleteHarmonizedTariffScheduleCodeTranslation(harmonizedTariffScheduleCodeTranslation, partyPK); 226 } else if(harmonizedTariffScheduleCodeTranslation != null && (description != null || overview != null)) { 227 var harmonizedTariffScheduleCodeTranslationValue = itemControl.getHarmonizedTariffScheduleCodeTranslationValue(harmonizedTariffScheduleCodeTranslation); 228 229 harmonizedTariffScheduleCodeTranslationValue.setDescription(description); 230 harmonizedTariffScheduleCodeTranslationValue.setOverviewMimeTypePK(overviewMimeType == null? null: overviewMimeType.getPrimaryKey()); 231 harmonizedTariffScheduleCodeTranslationValue.setOverview(overview); 232 itemControl.updateHarmonizedTariffScheduleCodeTranslationFromValue(harmonizedTariffScheduleCodeTranslationValue, partyPK); 233 } 234 } 235 236}