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.carrier.server.command; 018 019import com.echothree.control.user.carrier.common.edit.CarrierEditFactory; 020import com.echothree.control.user.carrier.common.edit.CarrierOptionEdit; 021import com.echothree.control.user.carrier.common.form.EditCarrierOptionForm; 022import com.echothree.control.user.carrier.common.result.CarrierResultFactory; 023import com.echothree.control.user.carrier.common.result.EditCarrierOptionResult; 024import com.echothree.control.user.carrier.common.spec.CarrierOptionSpec; 025import com.echothree.model.control.carrier.server.control.CarrierControl; 026import com.echothree.model.control.party.common.PartyTypes; 027import com.echothree.model.control.security.common.SecurityRoleGroups; 028import com.echothree.model.control.security.common.SecurityRoles; 029import com.echothree.model.control.selector.common.SelectorKinds; 030import com.echothree.model.control.selector.common.SelectorTypes; 031import com.echothree.model.control.selector.server.control.SelectorControl; 032import com.echothree.model.data.carrier.server.entity.CarrierOption; 033import com.echothree.model.data.party.server.entity.Party; 034import com.echothree.model.data.selector.server.entity.Selector; 035import com.echothree.model.data.user.common.pk.UserVisitPK; 036import com.echothree.util.common.command.EditMode; 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.server.control.BaseAbstractEditCommand; 041import com.echothree.util.server.control.CommandSecurityDefinition; 042import com.echothree.util.server.control.PartyTypeDefinition; 043import com.echothree.util.server.control.SecurityRoleDefinition; 044import java.util.List; 045import javax.enterprise.context.Dependent; 046import javax.inject.Inject; 047 048@Dependent 049public class EditCarrierOptionCommand 050 extends BaseAbstractEditCommand<CarrierOptionSpec, CarrierOptionEdit, EditCarrierOptionResult, CarrierOption, CarrierOption> { 051 052 private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION; 053 private final static List<FieldDefinition> SPEC_FIELD_DEFINITIONS; 054 private final static List<FieldDefinition> EDIT_FIELD_DEFINITIONS; 055 056 static { 057 COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(List.of( 058 new PartyTypeDefinition(PartyTypes.UTILITY.name(), null), 059 new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of( 060 new SecurityRoleDefinition(SecurityRoleGroups.CarrierOption.name(), SecurityRoles.Edit.name()) 061 )) 062 )); 063 064 SPEC_FIELD_DEFINITIONS = List.of( 065 new FieldDefinition("CarrierName", FieldType.ENTITY_NAME, true, null, null), 066 new FieldDefinition("CarrierOptionName", FieldType.ENTITY_NAME, true, null, null) 067 ); 068 069 EDIT_FIELD_DEFINITIONS = List.of( 070 new FieldDefinition("CarrierOptionName", FieldType.ENTITY_NAME, true, null, null), 071 new FieldDefinition("IsRecommended", FieldType.BOOLEAN, true, null, null), 072 new FieldDefinition("IsRequired", FieldType.BOOLEAN, true, null, null), 073 new FieldDefinition("RecommendedGeoCodeSelectorName", FieldType.ENTITY_NAME, false, null, null), 074 new FieldDefinition("RequiredGeoCodeSelectorName", FieldType.ENTITY_NAME, false, null, null), 075 new FieldDefinition("RecommendedItemSelectorName", FieldType.ENTITY_NAME, false, null, null), 076 new FieldDefinition("RequiredItemSelectorName", FieldType.ENTITY_NAME, false, null, null), 077 new FieldDefinition("RecommendedOrderSelectorName", FieldType.ENTITY_NAME, false, null, null), 078 new FieldDefinition("RequiredOrderSelectorName", FieldType.ENTITY_NAME, false, null, null), 079 new FieldDefinition("RecommendedShipmentSelectorName", FieldType.ENTITY_NAME, false, null, null), 080 new FieldDefinition("RequiredShipmentSelectorName", FieldType.ENTITY_NAME, false, null, null), 081 new FieldDefinition("IsDefault", FieldType.BOOLEAN, true, null, null), 082 new FieldDefinition("SortOrder", FieldType.SIGNED_INTEGER, true, null, null), 083 new FieldDefinition("Description", FieldType.STRING, false, 1L, 132L) 084 ); 085 } 086 087 @Inject 088 CarrierControl carrierControl; 089 090 @Inject 091 SelectorControl selectorControl; 092 093 094 /** Creates a new instance of EditCarrierOptionCommand */ 095 public EditCarrierOptionCommand() { 096 super(COMMAND_SECURITY_DEFINITION, SPEC_FIELD_DEFINITIONS, EDIT_FIELD_DEFINITIONS); 097 } 098 099 @Override 100 public EditCarrierOptionResult getResult() { 101 return CarrierResultFactory.getEditCarrierOptionResult(); 102 } 103 104 @Override 105 public CarrierOptionEdit getEdit() { 106 return CarrierEditFactory.getCarrierOptionEdit(); 107 } 108 109 Party carrierParty; 110 111 @Override 112 public CarrierOption getEntity(EditCarrierOptionResult result) { 113 CarrierOption carrierOption = null; 114 var carrierName = spec.getCarrierName(); 115 var carrier = carrierControl.getCarrierByName(carrierName); 116 117 if(carrier != null) { 118 var carrierOptionName = spec.getCarrierOptionName(); 119 120 carrierParty = carrier.getParty(); 121 122 if(editMode.equals(EditMode.LOCK) || editMode.equals(EditMode.ABANDON)) { 123 carrierOption = carrierControl.getCarrierOptionByName(carrierParty, carrierOptionName); 124 } else { // EditMode.UPDATE 125 carrierOption = carrierControl.getCarrierOptionByNameForUpdate(carrierParty, carrierOptionName); 126 } 127 128 if(carrierOption != null) { 129 result.setCarrierOption(carrierControl.getCarrierOptionTransfer(getUserVisit(), carrierOption)); 130 } else { 131 addExecutionError(ExecutionErrors.UnknownCarrierOptionName.name(), carrierName, carrierOptionName); 132 } 133 } else { 134 addExecutionError(ExecutionErrors.UnknownCarrierName.name(), carrierName); 135 } 136 137 return carrierOption; 138 } 139 140 @Override 141 public CarrierOption getLockEntity(CarrierOption carrierOption) { 142 return carrierOption; 143 } 144 145 @Override 146 public void fillInResult(EditCarrierOptionResult result, CarrierOption carrierOption) { 147 result.setCarrierOption(carrierControl.getCarrierOptionTransfer(getUserVisit(), carrierOption)); 148 } 149 150 Selector recommendedGeoCodeSelector; 151 Selector requiredGeoCodeSelector; 152 Selector recommendedItemSelector; 153 Selector requiredItemSelector; 154 Selector recommendedOrderSelector; 155 Selector requiredOrderSelector; 156 Selector recommendedShipmentSelector; 157 Selector requiredShipmentSelector; 158 159 @Override 160 public void doLock(CarrierOptionEdit edit, CarrierOption carrierOption) { 161 var carrierOptionDescription = carrierControl.getCarrierOptionDescription(carrierOption, getPreferredLanguage()); 162 var carrierOptionDetail = carrierOption.getLastDetail(); 163 164 recommendedGeoCodeSelector = carrierOptionDetail.getRecommendedGeoCodeSelector(); 165 requiredGeoCodeSelector = carrierOptionDetail.getRequiredGeoCodeSelector(); 166 recommendedItemSelector = carrierOptionDetail.getRecommendedItemSelector(); 167 requiredItemSelector = carrierOptionDetail.getRequiredItemSelector(); 168 recommendedOrderSelector = carrierOptionDetail.getRecommendedOrderSelector(); 169 requiredOrderSelector = carrierOptionDetail.getRequiredOrderSelector(); 170 recommendedShipmentSelector = carrierOptionDetail.getRecommendedShipmentSelector(); 171 requiredShipmentSelector = carrierOptionDetail.getRequiredShipmentSelector(); 172 173 edit.setCarrierOptionName(carrierOptionDetail.getCarrierOptionName()); 174 edit.setIsRecommended(carrierOptionDetail.getIsRecommended().toString()); 175 edit.setIsRequired(carrierOptionDetail.getIsRequired().toString()); 176 edit.setRecommendedGeoCodeSelectorName(recommendedGeoCodeSelector == null? null: recommendedGeoCodeSelector.getLastDetail().getSelectorName()); 177 edit.setRequiredGeoCodeSelectorName(requiredGeoCodeSelector == null? null: requiredGeoCodeSelector.getLastDetail().getSelectorName()); 178 edit.setRecommendedItemSelectorName(recommendedItemSelector == null? null: recommendedItemSelector.getLastDetail().getSelectorName()); 179 edit.setRequiredItemSelectorName(requiredItemSelector == null? null: requiredItemSelector.getLastDetail().getSelectorName()); 180 edit.setRecommendedOrderSelectorName(recommendedOrderSelector == null? null: recommendedOrderSelector.getLastDetail().getSelectorName()); 181 edit.setRequiredOrderSelectorName(requiredOrderSelector == null? null: requiredOrderSelector.getLastDetail().getSelectorName()); 182 edit.setRecommendedShipmentSelectorName(recommendedShipmentSelector == null? null: recommendedShipmentSelector.getLastDetail().getSelectorName()); 183 edit.setRequiredShipmentSelectorName(requiredShipmentSelector == null? null: requiredShipmentSelector.getLastDetail().getSelectorName()); 184 edit.setIsDefault(carrierOptionDetail.getIsDefault().toString()); 185 edit.setSortOrder(carrierOptionDetail.getSortOrder().toString()); 186 187 if(carrierOptionDescription != null) { 188 edit.setDescription(carrierOptionDescription.getDescription()); 189 } 190 } 191 192 @Override 193 public void canUpdate(CarrierOption carrierOption) { 194 var carrierOptionName = edit.getCarrierOptionName(); 195 var duplicateCarrierOption = carrierControl.getCarrierOptionByName(carrierParty, carrierOptionName); 196 197 if(duplicateCarrierOption == null || carrierOption.equals(duplicateCarrierOption)) { 198 var selectorKind = selectorControl.getSelectorKindByName(SelectorKinds.POSTAL_ADDRESS.name()); 199 200 if(selectorKind != null) { 201 var selectorType = selectorControl.getSelectorTypeByName(selectorKind, SelectorTypes.CARRIER_OPTION.name()); 202 203 if(selectorType != null) { 204 var recommendedGeoCodeSelectorName = edit.getRecommendedGeoCodeSelectorName(); 205 206 if(recommendedGeoCodeSelectorName != null) { 207 recommendedGeoCodeSelector = selectorControl.getSelectorByName(selectorType, recommendedGeoCodeSelectorName); 208 } 209 210 if(recommendedGeoCodeSelectorName == null || recommendedGeoCodeSelector != null) { 211 var requiredGeoCodeSelectorName = edit.getRequiredGeoCodeSelectorName(); 212 213 if(requiredGeoCodeSelectorName != null) { 214 requiredGeoCodeSelector = selectorControl.getSelectorByName(selectorType, requiredGeoCodeSelectorName); 215 } 216 217 if(requiredGeoCodeSelectorName == null || requiredGeoCodeSelector != null) { 218 selectorKind = selectorControl.getSelectorKindByName(SelectorKinds.ITEM.name()); 219 220 if(selectorKind != null) { 221 selectorType = selectorControl.getSelectorTypeByName(selectorKind, SelectorTypes.CARRIER_OPTION.name()); 222 223 if(selectorType != null) { 224 var recommendedItemSelectorName = edit.getRecommendedItemSelectorName(); 225 226 if(recommendedItemSelectorName != null) { 227 recommendedItemSelector = selectorControl.getSelectorByName(selectorType, recommendedItemSelectorName); 228 } 229 230 if(recommendedItemSelectorName == null || recommendedItemSelector != null) { 231 var requiredItemSelectorName = edit.getRequiredItemSelectorName(); 232 233 if(requiredItemSelectorName != null) { 234 requiredItemSelector = selectorControl.getSelectorByName(selectorType, requiredItemSelectorName); 235 } 236 237 if(requiredItemSelectorName == null || requiredItemSelector != null) { 238 selectorKind = selectorControl.getSelectorKindByName(SelectorKinds.ORDER.name()); 239 240 if(selectorKind != null) { 241 selectorType = selectorControl.getSelectorTypeByName(selectorKind, SelectorTypes.CARRIER_OPTION.name()); 242 243 if(selectorType != null) { 244 var recommendedOrderSelectorName = edit.getRecommendedOrderSelectorName(); 245 246 if(recommendedOrderSelectorName != null) { 247 recommendedOrderSelector = selectorControl.getSelectorByName(selectorType, recommendedOrderSelectorName); 248 } 249 250 if(recommendedOrderSelectorName == null || recommendedOrderSelector != null) { 251 var requiredOrderSelectorName = edit.getRequiredOrderSelectorName(); 252 253 if(requiredOrderSelectorName != null) { 254 requiredOrderSelector = selectorControl.getSelectorByName(selectorType, requiredOrderSelectorName); 255 } 256 257 if(requiredOrderSelectorName == null || requiredOrderSelector != null) { 258 selectorKind = selectorControl.getSelectorKindByName(SelectorKinds.SHIPMENT.name()); 259 260 if(selectorKind != null) { 261 selectorType = selectorControl.getSelectorTypeByName(selectorKind, SelectorTypes.CARRIER_OPTION.name()); 262 263 if(selectorType != null) { 264 var recommendedShipmentSelectorName = edit.getRecommendedShipmentSelectorName(); 265 266 if(recommendedShipmentSelectorName != null) { 267 recommendedShipmentSelector = selectorControl.getSelectorByName(selectorType, recommendedShipmentSelectorName); 268 } 269 270 if(recommendedShipmentSelectorName == null || recommendedShipmentSelector != null) { 271 var requiredShipmentSelectorName = edit.getRequiredShipmentSelectorName(); 272 273 if(requiredShipmentSelectorName != null) { 274 requiredShipmentSelector = selectorControl.getSelectorByName(selectorType, requiredShipmentSelectorName); 275 } 276 277 if(requiredShipmentSelectorName != null && requiredShipmentSelector == null) { 278 addExecutionError(ExecutionErrors.UnknownRequiredShipmentSelectorName.name(), requiredShipmentSelectorName); 279 } 280 } else { 281 addExecutionError(ExecutionErrors.UnknownRecommendedShipmentSelectorName.name(), recommendedShipmentSelectorName); 282 } 283 } else { 284 addExecutionError(ExecutionErrors.UnknownSelectorTypeName.name(), 285 SelectorKinds.SHIPMENT.name(), 286 SelectorTypes.CARRIER_OPTION.name()); 287 } 288 } else { 289 addExecutionError(ExecutionErrors.UnknownSelectorKindName.name(), SelectorKinds.SHIPMENT.name()); 290 } 291 } else { 292 addExecutionError(ExecutionErrors.UnknownRequiredOrderSelectorName.name(), requiredOrderSelectorName); 293 } 294 } else { 295 addExecutionError(ExecutionErrors.UnknownRecommendedOrderSelectorName.name(), recommendedOrderSelectorName); 296 } 297 } else { 298 addExecutionError(ExecutionErrors.UnknownSelectorTypeName.name(), 299 SelectorKinds.ORDER.name(), SelectorTypes.CARRIER_OPTION.name()); 300 } 301 } else { 302 addExecutionError(ExecutionErrors.UnknownSelectorKindName.name(), SelectorKinds.ORDER.name()); 303 } 304 } else { 305 addExecutionError(ExecutionErrors.UnknownRequiredItemSelectorName.name(), requiredItemSelectorName); 306 } 307 } else { 308 addExecutionError(ExecutionErrors.UnknownRecommendedItemSelectorName.name(), recommendedItemSelectorName); 309 } 310 } else { 311 addExecutionError(ExecutionErrors.UnknownSelectorTypeName.name(), SelectorKinds.ITEM.name(), 312 SelectorTypes.CARRIER_OPTION.name()); 313 } 314 } else { 315 addExecutionError(ExecutionErrors.UnknownSelectorKindName.name(), SelectorKinds.ITEM.name()); 316 } 317 } else { 318 addExecutionError(ExecutionErrors.UnknownRequiredGeoCodeSelectorName.name(), requiredGeoCodeSelectorName); 319 } 320 } else { 321 addExecutionError(ExecutionErrors.UnknownRecommendedGeoCodeSelectorName.name(), recommendedGeoCodeSelectorName); 322 } 323 } else { 324 addExecutionError(ExecutionErrors.UnknownSelectorTypeName.name(), SelectorKinds.POSTAL_ADDRESS.name(), 325 SelectorTypes.CARRIER_OPTION.name()); 326 } 327 } else { 328 addExecutionError(ExecutionErrors.UnknownSelectorKindName.name(), SelectorKinds.POSTAL_ADDRESS.name()); 329 } 330 } else { 331 addExecutionError(ExecutionErrors.DuplicateCarrierOptionName.name(), carrierOptionName); 332 } 333 } 334 335 @Override 336 public void doUpdate(CarrierOption carrierOption) { 337 var partyPK = getPartyPK(); 338 var carrierOptionDetailValue = carrierControl.getCarrierOptionDetailValueForUpdate(carrierOption); 339 var carrierOptionDescription = carrierControl.getCarrierOptionDescriptionForUpdate(carrierOption, getPreferredLanguage()); 340 var description = edit.getDescription(); 341 342 carrierOptionDetailValue.setCarrierOptionName(edit.getCarrierOptionName()); 343 carrierOptionDetailValue.setIsRecommended(Boolean.valueOf(edit.getIsRecommended())); 344 carrierOptionDetailValue.setIsRequired(Boolean.valueOf(edit.getIsRequired())); 345 carrierOptionDetailValue.setRecommendedGeoCodeSelectorPK(recommendedGeoCodeSelector.getPrimaryKey()); 346 carrierOptionDetailValue.setRequiredGeoCodeSelectorPK(requiredGeoCodeSelector.getPrimaryKey()); 347 carrierOptionDetailValue.setRecommendedItemSelectorPK(recommendedItemSelector.getPrimaryKey()); 348 carrierOptionDetailValue.setRequiredItemSelectorPK(requiredItemSelector.getPrimaryKey()); 349 carrierOptionDetailValue.setRecommendedOrderSelectorPK(recommendedOrderSelector.getPrimaryKey()); 350 carrierOptionDetailValue.setRequiredOrderSelectorPK(requiredOrderSelector.getPrimaryKey()); 351 carrierOptionDetailValue.setRecommendedShipmentSelectorPK(recommendedShipmentSelector.getPrimaryKey()); 352 carrierOptionDetailValue.setRequiredShipmentSelectorPK(requiredShipmentSelector.getPrimaryKey()); 353 carrierOptionDetailValue.setIsDefault(Boolean.valueOf(edit.getIsDefault())); 354 carrierOptionDetailValue.setSortOrder(Integer.valueOf(edit.getSortOrder())); 355 356 carrierControl.updateCarrierOptionFromValue(carrierOptionDetailValue, partyPK); 357 358 if(carrierOptionDescription == null && description != null) { 359 carrierControl.createCarrierOptionDescription(carrierOption, getPreferredLanguage(), description, partyPK); 360 } else { 361 if(carrierOptionDescription != null && description == null) { 362 carrierControl.deleteCarrierOptionDescription(carrierOptionDescription, partyPK); 363 } else { 364 if(carrierOptionDescription != null && description != null) { 365 var carrierOptionDescriptionValue = carrierControl.getCarrierOptionDescriptionValue(carrierOptionDescription); 366 367 carrierOptionDescriptionValue.setDescription(description); 368 carrierControl.updateCarrierOptionDescriptionFromValue(carrierOptionDescriptionValue, partyPK); 369 } 370 } 371 } 372 } 373 374}