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.offer.server.command; 018 019import com.echothree.control.user.offer.common.edit.OfferEdit; 020import com.echothree.control.user.offer.common.edit.OfferEditFactory; 021import com.echothree.control.user.offer.common.form.EditOfferForm; 022import com.echothree.control.user.offer.common.result.EditOfferResult; 023import com.echothree.control.user.offer.common.result.OfferResultFactory; 024import com.echothree.control.user.offer.common.spec.OfferSpec; 025import com.echothree.model.control.filter.common.FilterKinds; 026import com.echothree.model.control.filter.common.FilterTypes; 027import com.echothree.model.control.filter.server.control.FilterControl; 028import com.echothree.model.control.offer.server.control.OfferControl; 029import com.echothree.model.control.offer.server.logic.OfferLogic; 030import com.echothree.model.control.party.common.PartyTypes; 031import com.echothree.model.control.security.common.SecurityRoleGroups; 032import com.echothree.model.control.security.common.SecurityRoles; 033import com.echothree.model.control.selector.common.SelectorKinds; 034import com.echothree.model.control.selector.common.SelectorTypes; 035import com.echothree.model.control.selector.server.control.SelectorControl; 036import com.echothree.model.control.sequence.common.SequenceTypes; 037import com.echothree.model.control.sequence.server.control.SequenceControl; 038import com.echothree.model.data.filter.server.entity.Filter; 039import com.echothree.model.data.filter.server.entity.FilterKind; 040import com.echothree.model.data.filter.server.entity.FilterType; 041import com.echothree.model.data.offer.server.entity.Offer; 042import com.echothree.model.data.offer.server.entity.OfferDescription; 043import com.echothree.model.data.offer.server.entity.OfferDetail; 044import com.echothree.model.data.offer.server.value.OfferDescriptionValue; 045import com.echothree.model.data.offer.server.value.OfferDetailValue; 046import com.echothree.model.data.selector.server.entity.Selector; 047import com.echothree.model.data.selector.server.entity.SelectorKind; 048import com.echothree.model.data.selector.server.entity.SelectorType; 049import com.echothree.model.data.sequence.server.entity.Sequence; 050import com.echothree.model.data.sequence.server.entity.SequenceType; 051import com.echothree.model.data.user.common.pk.UserVisitPK; 052import com.echothree.util.common.command.BaseResult; 053import com.echothree.util.common.command.EditMode; 054import com.echothree.util.common.message.ExecutionErrors; 055import com.echothree.util.common.validation.FieldDefinition; 056import com.echothree.util.common.validation.FieldType; 057import com.echothree.util.server.control.BaseEditCommand; 058import com.echothree.util.server.control.CommandSecurityDefinition; 059import com.echothree.util.server.control.PartyTypeDefinition; 060import com.echothree.util.server.control.SecurityRoleDefinition; 061import com.echothree.util.server.persistence.Session; 062import java.util.Arrays; 063import java.util.Collections; 064import java.util.List; 065 066public class EditOfferCommand 067 extends BaseEditCommand<OfferSpec, OfferEdit> { 068 069 private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION; 070 private final static List<FieldDefinition> SPEC_FIELD_DEFINITIONS; 071 private final static List<FieldDefinition> EDIT_FIELD_DEFINITIONS; 072 073 static { 074 COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(Collections.unmodifiableList(Arrays.asList( 075 new PartyTypeDefinition(PartyTypes.UTILITY.name(), null), 076 new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), Collections.unmodifiableList(Arrays.asList( 077 new SecurityRoleDefinition(SecurityRoleGroups.Offer.name(), SecurityRoles.Edit.name()) 078 ))) 079 ))); 080 081 SPEC_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList( 082 new FieldDefinition("OfferName", FieldType.ENTITY_NAME, true, null, null) 083 )); 084 085 EDIT_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList( 086 new FieldDefinition("OfferName", FieldType.ENTITY_NAME, true, null, null), 087 new FieldDefinition("SalesOrderSequenceName", FieldType.ENTITY_NAME, false, null, null), 088 new FieldDefinition("OfferItemSelectorName", FieldType.ENTITY_NAME, false, null, null), 089 new FieldDefinition("OfferItemPriceFilterName", FieldType.ENTITY_NAME, false, null, null), 090 new FieldDefinition("IsDefault", FieldType.BOOLEAN, true, null, null), 091 new FieldDefinition("SortOrder", FieldType.SIGNED_INTEGER, true, null, null), 092 new FieldDefinition("Description", FieldType.STRING, false, 1L, 132L) 093 )); 094 } 095 096 /** Creates a new instance of EditOfferCommand */ 097 public EditOfferCommand(UserVisitPK userVisitPK, EditOfferForm form) { 098 super(userVisitPK, form, COMMAND_SECURITY_DEFINITION, SPEC_FIELD_DEFINITIONS, EDIT_FIELD_DEFINITIONS); 099 } 100 101 @Override 102 protected BaseResult execute() { 103 var offerControl = Session.getModelController(OfferControl.class); 104 EditOfferResult result = OfferResultFactory.getEditOfferResult(); 105 106 if(editMode.equals(EditMode.LOCK)) { 107 String offerName = spec.getOfferName(); 108 Offer offer = offerControl.getOfferByName(offerName); 109 110 if(offer != null) { 111 result.setOffer(offerControl.getOfferTransfer(getUserVisit(), offer)); 112 113 if(lockEntity(offer)) { 114 OfferDescription offerDescription = offerControl.getOfferDescription(offer, getPreferredLanguage()); 115 OfferEdit edit = OfferEditFactory.getOfferEdit(); 116 OfferDetail offerDetail = offer.getLastDetail(); 117 Sequence salesOrderSequence = offerDetail.getSalesOrderSequence(); 118 Selector offerItemSelector = offerDetail.getOfferItemSelector(); 119 Filter offerItemPriceFilter = offerDetail.getOfferItemPriceFilter(); 120 121 result.setEdit(edit); 122 edit.setOfferName(offerDetail.getOfferName()); 123 edit.setSalesOrderSequenceName(salesOrderSequence == null? null: salesOrderSequence.getLastDetail().getSequenceName()); 124 edit.setOfferItemSelectorName(offerItemSelector == null? null: offerItemSelector.getLastDetail().getSelectorName()); 125 edit.setOfferItemPriceFilterName(offerItemPriceFilter == null? null: offerItemPriceFilter.getLastDetail().getFilterName()); 126 edit.setIsDefault(offerDetail.getIsDefault().toString()); 127 edit.setSortOrder(offerDetail.getSortOrder().toString()); 128 129 if(offerDescription != null) { 130 edit.setDescription(offerDescription.getDescription()); 131 } 132 } else { 133 addExecutionError(ExecutionErrors.EntityLockFailed.name()); 134 } 135 136 result.setEntityLock(getEntityLockTransfer(offer)); 137 } else { 138 addExecutionError(ExecutionErrors.UnknownOfferName.name(), offerName); 139 } 140 } else if(editMode.equals(EditMode.UPDATE)) { 141 String offerName = spec.getOfferName(); 142 Offer offer = offerControl.getOfferByNameForUpdate(offerName); 143 144 if(offer != null) { 145 offerName = edit.getOfferName(); 146 Offer duplicateOffer = offerControl.getOfferByName(offerName); 147 148 if(duplicateOffer == null || offer.equals(duplicateOffer)) { 149 String salesOrderSequenceName = edit.getSalesOrderSequenceName(); 150 Sequence salesOrderSequence = null; 151 152 if(salesOrderSequenceName != null) { 153 var sequenceControl = Session.getModelController(SequenceControl.class); 154 SequenceType sequenceType = sequenceControl.getSequenceTypeByName(SequenceTypes.SALES_ORDER.name()); 155 156 if(sequenceType != null) { 157 salesOrderSequence = sequenceControl.getSequenceByName(sequenceType, salesOrderSequenceName); 158 } else { 159 addExecutionError(ExecutionErrors.UnknownSequenceTypeName.name(), SequenceTypes.SALES_ORDER.name()); 160 } 161 } 162 163 if(salesOrderSequenceName == null || salesOrderSequence != null) { 164 String offerItemSelectorName = edit.getOfferItemSelectorName(); 165 Selector offerItemSelector = null; 166 167 if(offerItemSelectorName != null) { 168 var selectorControl = Session.getModelController(SelectorControl.class); 169 SelectorKind selectorKind = selectorControl.getSelectorKindByName(SelectorKinds.ITEM.name()); 170 171 if(selectorKind != null) { 172 SelectorType selectorType = selectorControl.getSelectorTypeByName(selectorKind, 173 SelectorTypes.OFFER.name()); 174 175 if(selectorType != null) { 176 offerItemSelector = selectorControl.getSelectorByName(selectorType, offerItemSelectorName); 177 } else { 178 addExecutionError(ExecutionErrors.UnknownSelectorTypeName.name(), SelectorTypes.OFFER.name()); 179 } 180 } else { 181 addExecutionError(ExecutionErrors.UnknownSelectorKindName.name(), SelectorKinds.ITEM.name()); 182 } 183 } 184 185 if(offerItemSelectorName == null || offerItemSelector != null) { 186 String offerItemPriceFilterName = edit.getOfferItemPriceFilterName(); 187 Filter offerItemPriceFilter = null; 188 189 if(offerItemPriceFilterName != null) { 190 var filterControl = Session.getModelController(FilterControl.class); 191 FilterKind filterKind = filterControl.getFilterKindByName(FilterKinds.PRICE.name()); 192 FilterType filterType = filterControl.getFilterTypeByName(filterKind, FilterTypes.OFFER_ITEM_PRICE.name()); 193 194 if(filterType != null) { 195 offerItemPriceFilter = filterControl.getFilterByName(filterType, offerItemPriceFilterName); 196 } 197 } 198 199 if(offerItemPriceFilterName == null || offerItemPriceFilter != null) { 200 if(lockEntityForUpdate(offer)) { 201 try { 202 var partyPK = getPartyPK(); 203 OfferDetailValue offerDetailValue = offerControl.getOfferDetailValueForUpdate(offer); 204 OfferDescription offerDescription = offerControl.getOfferDescriptionForUpdate(offer, getPreferredLanguage()); 205 String description = edit.getDescription(); 206 207 offerDetailValue.setOfferName(edit.getOfferName()); 208 offerDetailValue.setSalesOrderSequencePK(salesOrderSequence == null? null: salesOrderSequence.getPrimaryKey()); 209 offerDetailValue.setOfferItemSelectorPK(offerItemSelector == null? null: offerItemSelector.getPrimaryKey()); 210 offerDetailValue.setOfferItemPriceFilterPK(offerItemPriceFilter == null? null: offerItemPriceFilter.getPrimaryKey()); 211 offerDetailValue.setIsDefault(Boolean.valueOf(edit.getIsDefault())); 212 offerDetailValue.setSortOrder(Integer.valueOf(edit.getSortOrder())); 213 214 OfferLogic.getInstance().updateOfferFromValue(offerDetailValue, partyPK); 215 216 if(offerDescription == null && description != null) { 217 offerControl.createOfferDescription(offer, getPreferredLanguage(), description, partyPK); 218 } else if(offerDescription != null && description == null) { 219 offerControl.deleteOfferDescription(offerDescription, partyPK); 220 } else if(offerDescription != null && description != null) { 221 OfferDescriptionValue offerDescriptionValue = offerControl.getOfferDescriptionValue(offerDescription); 222 223 offerDescriptionValue.setDescription(description); 224 offerControl.updateOfferDescriptionFromValue(offerDescriptionValue, partyPK); 225 } 226 } finally { 227 unlockEntity(offer); 228 } 229 } else { 230 addExecutionError(ExecutionErrors.EntityLockStale.name()); 231 } 232 } else { 233 addExecutionError(ExecutionErrors.UnknownOfferItemPriceFilterName.name(), offerItemPriceFilterName); 234 } 235 } else { 236 addExecutionError(ExecutionErrors.UnknownOfferItemSelectorName.name(), offerItemSelectorName); 237 } 238 } else { 239 addExecutionError(ExecutionErrors.UnknownSalesOrderSequenceName.name(), salesOrderSequenceName); 240 } 241 } else { 242 addExecutionError(ExecutionErrors.DuplicateOfferName.name(), offerName); 243 } 244 } else { 245 addExecutionError(ExecutionErrors.UnknownOfferName.name(), offerName); 246 } 247 } 248 249 return result; 250 } 251 252}