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 com.echothree.util.server.persistence.Session; 045import java.util.List; 046import javax.enterprise.context.Dependent; 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 /** Creates a new instance of EditCarrierOptionCommand */ 088 public EditCarrierOptionCommand() { 089 super(COMMAND_SECURITY_DEFINITION, SPEC_FIELD_DEFINITIONS, EDIT_FIELD_DEFINITIONS); 090 } 091 092 @Override 093 public EditCarrierOptionResult getResult() { 094 return CarrierResultFactory.getEditCarrierOptionResult(); 095 } 096 097 @Override 098 public CarrierOptionEdit getEdit() { 099 return CarrierEditFactory.getCarrierOptionEdit(); 100 } 101 102 Party carrierParty; 103 104 @Override 105 public CarrierOption getEntity(EditCarrierOptionResult result) { 106 var carrierControl = Session.getModelController(CarrierControl.class); 107 CarrierOption carrierOption = null; 108 var carrierName = spec.getCarrierName(); 109 var carrier = carrierControl.getCarrierByName(carrierName); 110 111 if(carrier != null) { 112 var carrierOptionName = spec.getCarrierOptionName(); 113 114 carrierParty = carrier.getParty(); 115 116 if(editMode.equals(EditMode.LOCK) || editMode.equals(EditMode.ABANDON)) { 117 carrierOption = carrierControl.getCarrierOptionByName(carrierParty, carrierOptionName); 118 } else { // EditMode.UPDATE 119 carrierOption = carrierControl.getCarrierOptionByNameForUpdate(carrierParty, carrierOptionName); 120 } 121 122 if(carrierOption != null) { 123 result.setCarrierOption(carrierControl.getCarrierOptionTransfer(getUserVisit(), carrierOption)); 124 } else { 125 addExecutionError(ExecutionErrors.UnknownCarrierOptionName.name(), carrierName, carrierOptionName); 126 } 127 } else { 128 addExecutionError(ExecutionErrors.UnknownCarrierName.name(), carrierName); 129 } 130 131 return carrierOption; 132 } 133 134 @Override 135 public CarrierOption getLockEntity(CarrierOption carrierOption) { 136 return carrierOption; 137 } 138 139 @Override 140 public void fillInResult(EditCarrierOptionResult result, CarrierOption carrierOption) { 141 var carrierControl = Session.getModelController(CarrierControl.class); 142 143 result.setCarrierOption(carrierControl.getCarrierOptionTransfer(getUserVisit(), carrierOption)); 144 } 145 146 Selector recommendedGeoCodeSelector; 147 Selector requiredGeoCodeSelector; 148 Selector recommendedItemSelector; 149 Selector requiredItemSelector; 150 Selector recommendedOrderSelector; 151 Selector requiredOrderSelector; 152 Selector recommendedShipmentSelector; 153 Selector requiredShipmentSelector; 154 155 @Override 156 public void doLock(CarrierOptionEdit edit, CarrierOption carrierOption) { 157 var carrierControl = Session.getModelController(CarrierControl.class); 158 var carrierOptionDescription = carrierControl.getCarrierOptionDescription(carrierOption, getPreferredLanguage()); 159 var carrierOptionDetail = carrierOption.getLastDetail(); 160 161 recommendedGeoCodeSelector = carrierOptionDetail.getRecommendedGeoCodeSelector(); 162 requiredGeoCodeSelector = carrierOptionDetail.getRequiredGeoCodeSelector(); 163 recommendedItemSelector = carrierOptionDetail.getRecommendedItemSelector(); 164 requiredItemSelector = carrierOptionDetail.getRequiredItemSelector(); 165 recommendedOrderSelector = carrierOptionDetail.getRecommendedOrderSelector(); 166 requiredOrderSelector = carrierOptionDetail.getRequiredOrderSelector(); 167 recommendedShipmentSelector = carrierOptionDetail.getRecommendedShipmentSelector(); 168 requiredShipmentSelector = carrierOptionDetail.getRequiredShipmentSelector(); 169 170 edit.setCarrierOptionName(carrierOptionDetail.getCarrierOptionName()); 171 edit.setIsRecommended(carrierOptionDetail.getIsRecommended().toString()); 172 edit.setIsRequired(carrierOptionDetail.getIsRequired().toString()); 173 edit.setRecommendedGeoCodeSelectorName(recommendedGeoCodeSelector == null? null: recommendedGeoCodeSelector.getLastDetail().getSelectorName()); 174 edit.setRequiredGeoCodeSelectorName(requiredGeoCodeSelector == null? null: requiredGeoCodeSelector.getLastDetail().getSelectorName()); 175 edit.setRecommendedItemSelectorName(recommendedItemSelector == null? null: recommendedItemSelector.getLastDetail().getSelectorName()); 176 edit.setRequiredItemSelectorName(requiredItemSelector == null? null: requiredItemSelector.getLastDetail().getSelectorName()); 177 edit.setRecommendedOrderSelectorName(recommendedOrderSelector == null? null: recommendedOrderSelector.getLastDetail().getSelectorName()); 178 edit.setRequiredOrderSelectorName(requiredOrderSelector == null? null: requiredOrderSelector.getLastDetail().getSelectorName()); 179 edit.setRecommendedShipmentSelectorName(recommendedShipmentSelector == null? null: recommendedShipmentSelector.getLastDetail().getSelectorName()); 180 edit.setRequiredShipmentSelectorName(requiredShipmentSelector == null? null: requiredShipmentSelector.getLastDetail().getSelectorName()); 181 edit.setIsDefault(carrierOptionDetail.getIsDefault().toString()); 182 edit.setSortOrder(carrierOptionDetail.getSortOrder().toString()); 183 184 if(carrierOptionDescription != null) { 185 edit.setDescription(carrierOptionDescription.getDescription()); 186 } 187 } 188 189 @Override 190 public void canUpdate(CarrierOption carrierOption) { 191 var carrierControl = Session.getModelController(CarrierControl.class); 192 var carrierOptionName = edit.getCarrierOptionName(); 193 var duplicateCarrierOption = carrierControl.getCarrierOptionByName(carrierParty, carrierOptionName); 194 195 if(duplicateCarrierOption == null || carrierOption.equals(duplicateCarrierOption)) { 196 var selectorControl = Session.getModelController(SelectorControl.class); 197 var selectorKind = selectorControl.getSelectorKindByName(SelectorKinds.POSTAL_ADDRESS.name()); 198 199 if(selectorKind != null) { 200 var selectorType = selectorControl.getSelectorTypeByName(selectorKind, SelectorTypes.CARRIER_OPTION.name()); 201 202 if(selectorType != null) { 203 var recommendedGeoCodeSelectorName = edit.getRecommendedGeoCodeSelectorName(); 204 205 if(recommendedGeoCodeSelectorName != null) { 206 recommendedGeoCodeSelector = selectorControl.getSelectorByName(selectorType, recommendedGeoCodeSelectorName); 207 } 208 209 if(recommendedGeoCodeSelectorName == null || recommendedGeoCodeSelector != null) { 210 var requiredGeoCodeSelectorName = edit.getRequiredGeoCodeSelectorName(); 211 212 if(requiredGeoCodeSelectorName != null) { 213 requiredGeoCodeSelector = selectorControl.getSelectorByName(selectorType, requiredGeoCodeSelectorName); 214 } 215 216 if(requiredGeoCodeSelectorName == null || requiredGeoCodeSelector != null) { 217 selectorKind = selectorControl.getSelectorKindByName(SelectorKinds.ITEM.name()); 218 219 if(selectorKind != null) { 220 selectorType = selectorControl.getSelectorTypeByName(selectorKind, SelectorTypes.CARRIER_OPTION.name()); 221 222 if(selectorType != null) { 223 var recommendedItemSelectorName = edit.getRecommendedItemSelectorName(); 224 225 if(recommendedItemSelectorName != null) { 226 recommendedItemSelector = selectorControl.getSelectorByName(selectorType, recommendedItemSelectorName); 227 } 228 229 if(recommendedItemSelectorName == null || recommendedItemSelector != null) { 230 var requiredItemSelectorName = edit.getRequiredItemSelectorName(); 231 232 if(requiredItemSelectorName != null) { 233 requiredItemSelector = selectorControl.getSelectorByName(selectorType, requiredItemSelectorName); 234 } 235 236 if(requiredItemSelectorName == null || requiredItemSelector != null) { 237 selectorKind = selectorControl.getSelectorKindByName(SelectorKinds.ORDER.name()); 238 239 if(selectorKind != null) { 240 selectorType = selectorControl.getSelectorTypeByName(selectorKind, SelectorTypes.CARRIER_OPTION.name()); 241 242 if(selectorType != null) { 243 var recommendedOrderSelectorName = edit.getRecommendedOrderSelectorName(); 244 245 if(recommendedOrderSelectorName != null) { 246 recommendedOrderSelector = selectorControl.getSelectorByName(selectorType, recommendedOrderSelectorName); 247 } 248 249 if(recommendedOrderSelectorName == null || recommendedOrderSelector != null) { 250 var requiredOrderSelectorName = edit.getRequiredOrderSelectorName(); 251 252 if(requiredOrderSelectorName != null) { 253 requiredOrderSelector = selectorControl.getSelectorByName(selectorType, requiredOrderSelectorName); 254 } 255 256 if(requiredOrderSelectorName == null || requiredOrderSelector != null) { 257 selectorKind = selectorControl.getSelectorKindByName(SelectorKinds.SHIPMENT.name()); 258 259 if(selectorKind != null) { 260 selectorType = selectorControl.getSelectorTypeByName(selectorKind, SelectorTypes.CARRIER_OPTION.name()); 261 262 if(selectorType != null) { 263 var recommendedShipmentSelectorName = edit.getRecommendedShipmentSelectorName(); 264 265 if(recommendedShipmentSelectorName != null) { 266 recommendedShipmentSelector = selectorControl.getSelectorByName(selectorType, recommendedShipmentSelectorName); 267 } 268 269 if(recommendedShipmentSelectorName == null || recommendedShipmentSelector != null) { 270 var requiredShipmentSelectorName = edit.getRequiredShipmentSelectorName(); 271 272 if(requiredShipmentSelectorName != null) { 273 requiredShipmentSelector = selectorControl.getSelectorByName(selectorType, requiredShipmentSelectorName); 274 } 275 276 if(requiredShipmentSelectorName != null && requiredShipmentSelector == null) { 277 addExecutionError(ExecutionErrors.UnknownRequiredShipmentSelectorName.name(), requiredShipmentSelectorName); 278 } 279 } else { 280 addExecutionError(ExecutionErrors.UnknownRecommendedShipmentSelectorName.name(), recommendedShipmentSelectorName); 281 } 282 } else { 283 addExecutionError(ExecutionErrors.UnknownSelectorTypeName.name(), 284 SelectorKinds.SHIPMENT.name(), 285 SelectorTypes.CARRIER_OPTION.name()); 286 } 287 } else { 288 addExecutionError(ExecutionErrors.UnknownSelectorKindName.name(), SelectorKinds.SHIPMENT.name()); 289 } 290 } else { 291 addExecutionError(ExecutionErrors.UnknownRequiredOrderSelectorName.name(), requiredOrderSelectorName); 292 } 293 } else { 294 addExecutionError(ExecutionErrors.UnknownRecommendedOrderSelectorName.name(), recommendedOrderSelectorName); 295 } 296 } else { 297 addExecutionError(ExecutionErrors.UnknownSelectorTypeName.name(), 298 SelectorKinds.ORDER.name(), SelectorTypes.CARRIER_OPTION.name()); 299 } 300 } else { 301 addExecutionError(ExecutionErrors.UnknownSelectorKindName.name(), SelectorKinds.ORDER.name()); 302 } 303 } else { 304 addExecutionError(ExecutionErrors.UnknownRequiredItemSelectorName.name(), requiredItemSelectorName); 305 } 306 } else { 307 addExecutionError(ExecutionErrors.UnknownRecommendedItemSelectorName.name(), recommendedItemSelectorName); 308 } 309 } else { 310 addExecutionError(ExecutionErrors.UnknownSelectorTypeName.name(), SelectorKinds.ITEM.name(), 311 SelectorTypes.CARRIER_OPTION.name()); 312 } 313 } else { 314 addExecutionError(ExecutionErrors.UnknownSelectorKindName.name(), SelectorKinds.ITEM.name()); 315 } 316 } else { 317 addExecutionError(ExecutionErrors.UnknownRequiredGeoCodeSelectorName.name(), requiredGeoCodeSelectorName); 318 } 319 } else { 320 addExecutionError(ExecutionErrors.UnknownRecommendedGeoCodeSelectorName.name(), recommendedGeoCodeSelectorName); 321 } 322 } else { 323 addExecutionError(ExecutionErrors.UnknownSelectorTypeName.name(), SelectorKinds.POSTAL_ADDRESS.name(), 324 SelectorTypes.CARRIER_OPTION.name()); 325 } 326 } else { 327 addExecutionError(ExecutionErrors.UnknownSelectorKindName.name(), SelectorKinds.POSTAL_ADDRESS.name()); 328 } 329 } else { 330 addExecutionError(ExecutionErrors.DuplicateCarrierOptionName.name(), carrierOptionName); 331 } 332 } 333 334 @Override 335 public void doUpdate(CarrierOption carrierOption) { 336 var carrierControl = Session.getModelController(CarrierControl.class); 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}