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.OfferEditFactory;
020import com.echothree.control.user.offer.common.edit.OfferUseEdit;
021import com.echothree.control.user.offer.common.form.EditOfferUseForm;
022import com.echothree.control.user.offer.common.result.EditOfferUseResult;
023import com.echothree.control.user.offer.common.result.OfferResultFactory;
024import com.echothree.control.user.offer.common.spec.OfferUseSpec;
025import com.echothree.model.control.offer.server.control.OfferControl;
026import com.echothree.model.control.offer.server.control.OfferUseControl;
027import com.echothree.model.control.offer.server.control.UseControl;
028import com.echothree.model.control.party.common.PartyTypes;
029import com.echothree.model.control.security.common.SecurityRoleGroups;
030import com.echothree.model.control.security.common.SecurityRoles;
031import com.echothree.model.control.sequence.common.SequenceTypes;
032import com.echothree.model.control.sequence.server.control.SequenceControl;
033import com.echothree.model.data.offer.server.entity.Offer;
034import com.echothree.model.data.offer.server.entity.OfferUse;
035import com.echothree.model.data.offer.server.entity.OfferUseDetail;
036import com.echothree.model.data.offer.server.entity.Use;
037import com.echothree.model.data.offer.server.value.OfferUseDetailValue;
038import com.echothree.model.data.sequence.server.entity.Sequence;
039import com.echothree.model.data.sequence.server.entity.SequenceType;
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;
054
055public class EditOfferUseCommand
056        extends BaseEditCommand<OfferUseSpec, OfferUseEdit> {
057    
058    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
059    private final static List<FieldDefinition> SPEC_FIELD_DEFINITIONS;
060    private final static List<FieldDefinition> EDIT_FIELD_DEFINITIONS;
061    
062    static {
063        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(Collections.unmodifiableList(Arrays.asList(
064                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
065                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), Collections.unmodifiableList(Arrays.asList(
066                        new SecurityRoleDefinition(SecurityRoleGroups.OfferUse.name(), SecurityRoles.Edit.name())
067                        )))
068                )));
069        
070        SPEC_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
071                new FieldDefinition("OfferName", FieldType.ENTITY_NAME, true, null, null),
072                new FieldDefinition("UseName", FieldType.ENTITY_NAME, true, null, null)
073                ));
074        
075        EDIT_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
076                new FieldDefinition("SalesOrderSequenceName", FieldType.ENTITY_NAME, false, null, null)
077                ));
078    }
079    
080    /** Creates a new instance of EditOfferUseCommand */
081    public EditOfferUseCommand(UserVisitPK userVisitPK, EditOfferUseForm form) {
082        super(userVisitPK, form, COMMAND_SECURITY_DEFINITION, SPEC_FIELD_DEFINITIONS, EDIT_FIELD_DEFINITIONS);
083    }
084    
085    @Override
086    protected BaseResult execute() {
087        var offerControl = Session.getModelController(OfferControl.class);
088        EditOfferUseResult result = OfferResultFactory.getEditOfferUseResult();
089        String offerName = spec.getOfferName();
090        Offer offer = offerControl.getOfferByName(offerName);
091        
092        if(offer != null) {
093            var useControl = Session.getModelController(UseControl.class);
094            String useName = spec.getUseName();
095            Use use = useControl.getUseByName(useName);
096            
097            if(use != null) {
098                var offerUseControl = Session.getModelController(OfferUseControl.class);
099
100                if(editMode.equals(EditMode.LOCK)) {
101                    OfferUse offerUse = offerUseControl.getOfferUse(offer, use);
102                    
103                    if(offerUse != null) {
104                        result.setOfferUse(offerUseControl.getOfferUseTransfer(getUserVisit(), offerUse));
105                        
106                        if(lockEntity(offerUse)) {
107                            OfferUseEdit edit = OfferEditFactory.getOfferUseEdit();
108                            OfferUseDetail offerUseDetail = offerUse.getLastDetail();
109                            Sequence salesOrderSequence = offerUseDetail.getSalesOrderSequence();
110                            
111                            result.setEdit(edit);
112                            edit.setSalesOrderSequenceName(salesOrderSequence == null? null: salesOrderSequence.getLastDetail().getSequenceName());
113                        } else {
114                            addExecutionError(ExecutionErrors.EntityLockFailed.name());
115                        }
116                        
117                        result.setEntityLock(getEntityLockTransfer(offerUse));
118                    } else {
119                        addExecutionError(ExecutionErrors.UnknownOfferUse.name());
120                    }
121                } else if(editMode.equals(EditMode.UPDATE)) {
122                    OfferUse offerUse = offerUseControl.getOfferUseForUpdate(offer, use);
123                    
124                    if(offerUse != null) {
125                        String salesOrderSequenceName = edit.getSalesOrderSequenceName();
126                        Sequence salesOrderSequence = null;
127                        
128                        if(salesOrderSequenceName != null) {
129                            var sequenceControl = Session.getModelController(SequenceControl.class);
130                            SequenceType sequenceType = sequenceControl.getSequenceTypeByName(SequenceTypes.SALES_ORDER.name());
131                            
132                            if(sequenceType != null) {
133                                salesOrderSequence = sequenceControl.getSequenceByName(sequenceType, salesOrderSequenceName);
134                            } else {
135                                addExecutionError(ExecutionErrors.UnknownSequenceTypeName.name(), SequenceTypes.SALES_ORDER.name());
136                            }
137                        }
138                        
139                        if(salesOrderSequenceName == null || salesOrderSequence != null) {
140                            if(lockEntityForUpdate(offerUse)) {
141                                try {
142                                    OfferUseDetailValue offerUseDetailValue = offerUseControl.getOfferUseDetailValueForUpdate(offerUse);
143                                    
144                                    offerUseDetailValue.setSalesOrderSequencePK(salesOrderSequence == null? null: salesOrderSequence.getPrimaryKey());
145
146                                    offerUseControl.updateOfferUseFromValue(offerUseDetailValue, getPartyPK());
147                                } finally {
148                                    unlockEntity(offerUse);
149                                }
150                            } else {
151                                addExecutionError(ExecutionErrors.EntityLockStale.name());
152                            }
153                        } else {
154                            addExecutionError(ExecutionErrors.UnknownSalesOrderSequenceName.name(), salesOrderSequenceName);
155                        }
156                    } else {
157                        addExecutionError(ExecutionErrors.UnknownOfferUse.name());
158                    }
159                }
160            } else {
161                addExecutionError(ExecutionErrors.UnknownUseName.name(), useName);
162            }
163        }  else {
164            addExecutionError(ExecutionErrors.UnknownOfferName.name(), offerName);
165        }
166        
167        return result;
168    }
169    
170}