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