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