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