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.CarrierServiceOptionEdit; 021import com.echothree.control.user.carrier.common.form.EditCarrierServiceOptionForm; 022import com.echothree.control.user.carrier.common.result.CarrierResultFactory; 023import com.echothree.control.user.carrier.common.result.EditCarrierServiceOptionResult; 024import com.echothree.control.user.carrier.common.spec.CarrierServiceOptionSpec; 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.CarrierServiceOption; 033import com.echothree.model.data.selector.server.entity.Selector; 034import com.echothree.model.data.user.common.pk.UserVisitPK; 035import com.echothree.util.common.command.EditMode; 036import com.echothree.util.common.message.ExecutionErrors; 037import com.echothree.util.common.validation.FieldDefinition; 038import com.echothree.util.common.validation.FieldType; 039import com.echothree.util.server.control.BaseAbstractEditCommand; 040import com.echothree.util.server.control.CommandSecurityDefinition; 041import com.echothree.util.server.control.PartyTypeDefinition; 042import com.echothree.util.server.control.SecurityRoleDefinition; 043import com.echothree.util.server.persistence.Session; 044import java.util.List; 045import javax.enterprise.context.Dependent; 046 047@Dependent 048public class EditCarrierServiceOptionCommand 049 extends BaseAbstractEditCommand<CarrierServiceOptionSpec, CarrierServiceOptionEdit, EditCarrierServiceOptionResult, CarrierServiceOption, CarrierServiceOption> { 050 051 private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION; 052 private final static List<FieldDefinition> SPEC_FIELD_DEFINITIONS; 053 private final static List<FieldDefinition> EDIT_FIELD_DEFINITIONS; 054 055 static { 056 COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(List.of( 057 new PartyTypeDefinition(PartyTypes.UTILITY.name(), null), 058 new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of( 059 new SecurityRoleDefinition(SecurityRoleGroups.CarrierServiceOption.name(), SecurityRoles.Edit.name()) 060 )) 061 )); 062 063 SPEC_FIELD_DEFINITIONS = List.of( 064 new FieldDefinition("CarrierName", FieldType.ENTITY_NAME, true, null, null), 065 new FieldDefinition("CarrierServiceName", 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("IsRecommended", FieldType.BOOLEAN, true, null, null), 071 new FieldDefinition("IsRequired", FieldType.BOOLEAN, true, null, null), 072 new FieldDefinition("RecommendedGeoCodeSelectorName", FieldType.ENTITY_NAME, false, null, null), 073 new FieldDefinition("RequiredGeoCodeSelectorName", FieldType.ENTITY_NAME, false, null, null), 074 new FieldDefinition("RecommendedItemSelectorName", FieldType.ENTITY_NAME, false, null, null), 075 new FieldDefinition("RequiredItemSelectorName", FieldType.ENTITY_NAME, false, null, null), 076 new FieldDefinition("RecommendedOrderSelectorName", FieldType.ENTITY_NAME, false, null, null), 077 new FieldDefinition("RequiredOrderSelectorName", FieldType.ENTITY_NAME, false, null, null), 078 new FieldDefinition("RecommendedShipmentSelectorName", FieldType.ENTITY_NAME, false, null, null), 079 new FieldDefinition("RequiredShipmentSelectorName", FieldType.ENTITY_NAME, false, null, null) 080 ); 081 } 082 083 /** Creates a new instance of EditCarrierServiceOptionCommand */ 084 public EditCarrierServiceOptionCommand() { 085 super(COMMAND_SECURITY_DEFINITION, SPEC_FIELD_DEFINITIONS, EDIT_FIELD_DEFINITIONS); 086 } 087 088 @Override 089 public EditCarrierServiceOptionResult getResult() { 090 return CarrierResultFactory.getEditCarrierServiceOptionResult(); 091 } 092 093 @Override 094 public CarrierServiceOptionEdit getEdit() { 095 return CarrierEditFactory.getCarrierServiceOptionEdit(); 096 } 097 098 @Override 099 public CarrierServiceOption getEntity(EditCarrierServiceOptionResult result) { 100 var carrierControl = Session.getModelController(CarrierControl.class); 101 CarrierServiceOption carrierServiceOption = null; 102 var carrierName = spec.getCarrierName(); 103 var carrier = carrierControl.getCarrierByName(carrierName); 104 105 if(carrier != null) { 106 var carrierParty = carrier.getParty(); 107 var carrierServiceName = spec.getCarrierServiceName(); 108 var carrierService = carrierControl.getCarrierServiceByName(carrierParty, carrierServiceName); 109 110 if(carrierService != null) { 111 var carrierOptionName = spec.getCarrierOptionName(); 112 var carrierOption = carrierControl.getCarrierOptionByName(carrierParty, carrierOptionName); 113 114 if(carrierOption != null) { 115 if(editMode.equals(EditMode.LOCK) || editMode.equals(EditMode.ABANDON)) { 116 carrierServiceOption = carrierControl.getCarrierServiceOption(carrierService, carrierOption); 117 } else { // EditMode.UPDATE 118 carrierServiceOption = carrierControl.getCarrierServiceOptionForUpdate(carrierService, carrierOption); 119 } 120 121 if(carrierServiceOption != null) { 122 result.setCarrierServiceOption(carrierControl.getCarrierServiceOptionTransfer(getUserVisit(), carrierServiceOption)); 123 } else { 124 addExecutionError(ExecutionErrors.UnknownCarrierServiceOption.name(), carrierName, carrierService, carrierOptionName); 125 } 126 } else { 127 addExecutionError(ExecutionErrors.UnknownCarrierOptionName.name(), carrierName, carrierOptionName); 128 } 129 } else { 130 addExecutionError(ExecutionErrors.UnknownCarrierServiceName.name(), carrierName, carrierServiceName); 131 } 132 } else { 133 addExecutionError(ExecutionErrors.UnknownCarrierName.name(), carrierName); 134 } 135 136 return carrierServiceOption; 137 } 138 139 @Override 140 public CarrierServiceOption getLockEntity(CarrierServiceOption carrierServiceOption) { 141 return carrierServiceOption; 142 } 143 144 @Override 145 public void fillInResult(EditCarrierServiceOptionResult result, CarrierServiceOption carrierServiceOption) { 146 var carrierControl = Session.getModelController(CarrierControl.class); 147 148 result.setCarrierServiceOption(carrierControl.getCarrierServiceOptionTransfer(getUserVisit(), carrierServiceOption)); 149 } 150 151 Selector recommendedGeoCodeSelector; 152 Selector requiredGeoCodeSelector; 153 Selector recommendedItemSelector; 154 Selector requiredItemSelector; 155 Selector recommendedOrderSelector; 156 Selector requiredOrderSelector; 157 Selector recommendedShipmentSelector; 158 Selector requiredShipmentSelector; 159 160 @Override 161 public void doLock(CarrierServiceOptionEdit edit, CarrierServiceOption carrierServiceOption) { 162 recommendedGeoCodeSelector = carrierServiceOption.getRecommendedGeoCodeSelector(); 163 requiredGeoCodeSelector = carrierServiceOption.getRequiredGeoCodeSelector(); 164 recommendedItemSelector = carrierServiceOption.getRecommendedItemSelector(); 165 requiredItemSelector = carrierServiceOption.getRequiredItemSelector(); 166 recommendedOrderSelector = carrierServiceOption.getRecommendedOrderSelector(); 167 requiredOrderSelector = carrierServiceOption.getRequiredOrderSelector(); 168 recommendedShipmentSelector = carrierServiceOption.getRecommendedShipmentSelector(); 169 requiredShipmentSelector = carrierServiceOption.getRequiredShipmentSelector(); 170 171 edit.setIsRecommended(carrierServiceOption.getIsRecommended().toString()); 172 edit.setIsRequired(carrierServiceOption.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 } 182 183 @Override 184 public void canUpdate(CarrierServiceOption carrierServiceOption) { 185 var selectorControl = Session.getModelController(SelectorControl.class); 186 var selectorKind = selectorControl.getSelectorKindByName(SelectorKinds.POSTAL_ADDRESS.name()); 187 188 if(selectorKind != null) { 189 var selectorType = selectorControl.getSelectorTypeByName(selectorKind, SelectorTypes.CARRIER_OPTION.name()); 190 191 if(selectorType != null) { 192 var recommendedGeoCodeSelectorName = edit.getRecommendedGeoCodeSelectorName(); 193 194 if(recommendedGeoCodeSelectorName != null) { 195 recommendedGeoCodeSelector = selectorControl.getSelectorByName(selectorType, recommendedGeoCodeSelectorName); 196 } 197 198 if(recommendedGeoCodeSelectorName == null || recommendedGeoCodeSelector != null) { 199 var requiredGeoCodeSelectorName = edit.getRequiredGeoCodeSelectorName(); 200 201 if(requiredGeoCodeSelectorName != null) { 202 requiredGeoCodeSelector = selectorControl.getSelectorByName(selectorType, requiredGeoCodeSelectorName); 203 } 204 205 if(requiredGeoCodeSelectorName == null || requiredGeoCodeSelector != null) { 206 selectorKind = selectorControl.getSelectorKindByName(SelectorKinds.ITEM.name()); 207 208 if(selectorKind != null) { 209 selectorType = selectorControl.getSelectorTypeByName(selectorKind, SelectorTypes.CARRIER_OPTION.name()); 210 211 if(selectorType != null) { 212 var recommendedItemSelectorName = edit.getRecommendedItemSelectorName(); 213 214 if(recommendedItemSelectorName != null) { 215 recommendedItemSelector = selectorControl.getSelectorByName(selectorType, recommendedItemSelectorName); 216 } 217 218 if(recommendedItemSelectorName == null || recommendedItemSelector != null) { 219 var requiredItemSelectorName = edit.getRequiredItemSelectorName(); 220 221 if(requiredItemSelectorName != null) { 222 requiredItemSelector = selectorControl.getSelectorByName(selectorType, requiredItemSelectorName); 223 } 224 225 if(requiredItemSelectorName == null || requiredItemSelector != null) { 226 selectorKind = selectorControl.getSelectorKindByName(SelectorKinds.ORDER.name()); 227 228 if(selectorKind != null) { 229 selectorType = selectorControl.getSelectorTypeByName(selectorKind, SelectorTypes.CARRIER_OPTION.name()); 230 231 if(selectorType != null) { 232 var recommendedOrderSelectorName = edit.getRecommendedOrderSelectorName(); 233 234 if(recommendedOrderSelectorName != null) { 235 recommendedOrderSelector = selectorControl.getSelectorByName(selectorType, recommendedOrderSelectorName); 236 } 237 238 if(recommendedOrderSelectorName == null || recommendedOrderSelector != null) { 239 var requiredOrderSelectorName = edit.getRequiredOrderSelectorName(); 240 241 if(requiredOrderSelectorName != null) { 242 requiredOrderSelector = selectorControl.getSelectorByName(selectorType, requiredOrderSelectorName); 243 } 244 245 if(requiredOrderSelectorName == null || requiredOrderSelector != null) { 246 selectorKind = selectorControl.getSelectorKindByName(SelectorKinds.SHIPMENT.name()); 247 248 if(selectorKind != null) { 249 selectorType = selectorControl.getSelectorTypeByName(selectorKind, SelectorTypes.CARRIER_OPTION.name()); 250 251 if(selectorType != null) { 252 var recommendedShipmentSelectorName = edit.getRecommendedShipmentSelectorName(); 253 254 if(recommendedShipmentSelectorName != null) { 255 recommendedShipmentSelector = selectorControl.getSelectorByName(selectorType, recommendedShipmentSelectorName); 256 } 257 258 if(recommendedShipmentSelectorName == null || recommendedShipmentSelector != null) { 259 var requiredShipmentSelectorName = edit.getRequiredShipmentSelectorName(); 260 261 if(requiredShipmentSelectorName != null) { 262 requiredShipmentSelector = selectorControl.getSelectorByName(selectorType, requiredShipmentSelectorName); 263 } 264 265 if(requiredShipmentSelectorName != null && requiredShipmentSelector == null) { 266 addExecutionError(ExecutionErrors.UnknownRequiredShipmentSelectorName.name(), requiredShipmentSelectorName); 267 } 268 } else { 269 addExecutionError(ExecutionErrors.UnknownRecommendedShipmentSelectorName.name(), recommendedShipmentSelectorName); 270 } 271 } else { 272 addExecutionError(ExecutionErrors.UnknownSelectorTypeName.name(), 273 SelectorKinds.SHIPMENT.name(), 274 SelectorTypes.CARRIER_OPTION.name()); 275 } 276 } else { 277 addExecutionError(ExecutionErrors.UnknownSelectorKindName.name(), SelectorKinds.SHIPMENT.name()); 278 } 279 } else { 280 addExecutionError(ExecutionErrors.UnknownRequiredOrderSelectorName.name(), requiredOrderSelectorName); 281 } 282 } else { 283 addExecutionError(ExecutionErrors.UnknownRecommendedOrderSelectorName.name(), recommendedOrderSelectorName); 284 } 285 } else { 286 addExecutionError(ExecutionErrors.UnknownSelectorTypeName.name(), 287 SelectorKinds.ORDER.name(), SelectorTypes.CARRIER_OPTION.name()); 288 } 289 } else { 290 addExecutionError(ExecutionErrors.UnknownSelectorKindName.name(), SelectorKinds.ORDER.name()); 291 } 292 } else { 293 addExecutionError(ExecutionErrors.UnknownRequiredItemSelectorName.name(), requiredItemSelectorName); 294 } 295 } else { 296 addExecutionError(ExecutionErrors.UnknownRecommendedItemSelectorName.name(), recommendedItemSelectorName); 297 } 298 } else { 299 addExecutionError(ExecutionErrors.UnknownSelectorTypeName.name(), SelectorKinds.ITEM.name(), 300 SelectorTypes.CARRIER_OPTION.name()); 301 } 302 } else { 303 addExecutionError(ExecutionErrors.UnknownSelectorKindName.name(), SelectorKinds.ITEM.name()); 304 } 305 } else { 306 addExecutionError(ExecutionErrors.UnknownRequiredGeoCodeSelectorName.name(), requiredGeoCodeSelectorName); 307 } 308 } else { 309 addExecutionError(ExecutionErrors.UnknownRecommendedGeoCodeSelectorName.name(), recommendedGeoCodeSelectorName); 310 } 311 } else { 312 addExecutionError(ExecutionErrors.UnknownSelectorTypeName.name(), SelectorKinds.POSTAL_ADDRESS.name(), 313 SelectorTypes.CARRIER_OPTION.name()); 314 } 315 } else { 316 addExecutionError(ExecutionErrors.UnknownSelectorKindName.name(), SelectorKinds.POSTAL_ADDRESS.name()); 317 } 318 } 319 320 @Override 321 public void doUpdate(CarrierServiceOption carrierServiceOption) { 322 var carrierControl = Session.getModelController(CarrierControl.class); 323 var partyPK = getPartyPK(); 324 var carrierServiceOptionValue = carrierControl.getCarrierServiceOptionValue(carrierServiceOption); 325 326 carrierServiceOptionValue.setIsRecommended(Boolean.valueOf(edit.getIsRecommended())); 327 carrierServiceOptionValue.setIsRequired(Boolean.valueOf(edit.getIsRequired())); 328 carrierServiceOptionValue.setRecommendedGeoCodeSelectorPK(recommendedGeoCodeSelector.getPrimaryKey()); 329 carrierServiceOptionValue.setRequiredGeoCodeSelectorPK(requiredGeoCodeSelector.getPrimaryKey()); 330 carrierServiceOptionValue.setRecommendedItemSelectorPK(recommendedItemSelector.getPrimaryKey()); 331 carrierServiceOptionValue.setRequiredItemSelectorPK(requiredItemSelector.getPrimaryKey()); 332 carrierServiceOptionValue.setRecommendedOrderSelectorPK(recommendedOrderSelector.getPrimaryKey()); 333 carrierServiceOptionValue.setRequiredOrderSelectorPK(requiredOrderSelector.getPrimaryKey()); 334 carrierServiceOptionValue.setRecommendedShipmentSelectorPK(recommendedShipmentSelector.getPrimaryKey()); 335 carrierServiceOptionValue.setRequiredShipmentSelectorPK(requiredShipmentSelector.getPrimaryKey()); 336 337 carrierControl.updateCarrierServiceOptionFromValue(carrierServiceOptionValue, partyPK); 338 } 339 340}