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.vendor.server.command;
018
019import com.echothree.control.user.vendor.common.edit.VendorEditFactory;
020import com.echothree.control.user.vendor.common.edit.VendorItemEdit;
021import com.echothree.control.user.vendor.common.form.EditVendorItemForm;
022import com.echothree.control.user.vendor.common.result.VendorResultFactory;
023import com.echothree.control.user.vendor.common.spec.VendorItemUniversalSpec;
024import com.echothree.model.control.cancellationpolicy.common.CancellationKinds;
025import com.echothree.model.control.cancellationpolicy.server.control.CancellationPolicyControl;
026import com.echothree.model.control.party.common.PartyTypes;
027import com.echothree.model.control.returnpolicy.common.ReturnKinds;
028import com.echothree.model.control.returnpolicy.server.control.ReturnPolicyControl;
029import com.echothree.model.control.security.common.SecurityRoleGroups;
030import com.echothree.model.control.security.common.SecurityRoles;
031import com.echothree.model.control.vendor.server.control.VendorControl;
032import com.echothree.model.control.vendor.server.logic.VendorItemLogic;
033import com.echothree.model.data.cancellationpolicy.server.entity.CancellationKind;
034import com.echothree.model.data.cancellationpolicy.server.entity.CancellationPolicy;
035import com.echothree.model.data.returnpolicy.server.entity.ReturnKind;
036import com.echothree.model.data.returnpolicy.server.entity.ReturnPolicy;
037import com.echothree.model.data.user.common.pk.UserVisitPK;
038import com.echothree.model.data.vendor.server.entity.VendorItemDetail;
039import com.echothree.model.data.vendor.server.value.VendorItemDetailValue;
040import com.echothree.util.common.command.BaseResult;
041import com.echothree.util.common.command.EditMode;
042import com.echothree.util.common.message.ExecutionErrors;
043import com.echothree.util.common.validation.FieldDefinition;
044import com.echothree.util.common.validation.FieldType;
045import com.echothree.util.server.control.BaseEditCommand;
046import com.echothree.util.server.control.CommandSecurityDefinition;
047import com.echothree.util.server.control.PartyTypeDefinition;
048import com.echothree.util.server.control.SecurityRoleDefinition;
049import com.echothree.util.server.persistence.Session;
050import java.util.Arrays;
051import java.util.Collections;
052import java.util.List;
053
054public class EditVendorItemCommand
055        extends BaseEditCommand<VendorItemUniversalSpec, VendorItemEdit> {
056    
057    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
058    private final static List<FieldDefinition> SPEC_FIELD_DEFINITIONS;
059    private final static List<FieldDefinition> EDIT_FIELD_DEFINITIONS;
060    
061    static {
062        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(Collections.unmodifiableList(Arrays.asList(
063                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
064                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), Collections.unmodifiableList(Arrays.asList(
065                    new SecurityRoleDefinition(SecurityRoleGroups.VendorItem.name(), SecurityRoles.Edit.name())
066                    )))
067                )));
068        
069        SPEC_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
070                new FieldDefinition("VendorName", FieldType.ENTITY_NAME, false, null, null),
071                new FieldDefinition("PartyName", FieldType.ENTITY_NAME, false, null, null),
072                new FieldDefinition("VendorItemName", FieldType.ENTITY_NAME, true, null, null),
073                new FieldDefinition("EntityRef", FieldType.ENTITY_REF, false, null, null),
074                new FieldDefinition("Key", FieldType.KEY, false, null, null),
075                new FieldDefinition("Guid", FieldType.GUID, false, null, null),
076                new FieldDefinition("Ulid", FieldType.ULID, false, null, null)
077                ));
078        
079        EDIT_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
080                new FieldDefinition("VendorItemName", FieldType.ENTITY_NAME, true, null, null),
081                new FieldDefinition("Description", FieldType.STRING, false, 1L, 132L),
082                new FieldDefinition("Priority", FieldType.SIGNED_INTEGER, true, null, null),
083                new FieldDefinition("CancellationPolicyName", FieldType.ENTITY_NAME, false, null, null),
084                new FieldDefinition("ReturnPolicyName", FieldType.ENTITY_NAME, false, null, null)
085                ));
086    }
087    
088    /** Creates a new instance of EditVendorItemCommand */
089    public EditVendorItemCommand(UserVisitPK userVisitPK, EditVendorItemForm form) {
090        super(userVisitPK, form, COMMAND_SECURITY_DEFINITION, SPEC_FIELD_DEFINITIONS, EDIT_FIELD_DEFINITIONS);
091    }
092    
093    @Override
094    protected BaseResult execute() {
095        var vendorControl = Session.getModelController(VendorControl.class);
096        var result = VendorResultFactory.getEditVendorItemResult();
097
098        if(editMode.equals(EditMode.LOCK)) {
099            var vendorItem = VendorItemLogic.getInstance().getVendorItemByUniversalSpec(this, spec);
100
101            if(!hasExecutionErrors()) {
102                result.setVendorItem(vendorControl.getVendorItemTransfer(getUserVisit(), vendorItem));
103
104                if(lockEntity(vendorItem)) {
105                    VendorItemEdit edit = VendorEditFactory.getVendorItemEdit();
106                    VendorItemDetail vendorItemDetail = vendorItem.getLastDetail();
107                    CancellationPolicy cancellationPolicy = vendorItemDetail.getCancellationPolicy();
108                    ReturnPolicy returnPolicy = vendorItemDetail.getReturnPolicy();
109
110                    result.setEdit(edit);
111                    edit.setVendorItemName(vendorItemDetail.getVendorItemName());
112                    edit.setDescription(vendorItemDetail.getDescription());
113                    edit.setPriority(vendorItemDetail.getPriority().toString());
114                    edit.setCancellationPolicyName(cancellationPolicy == null? null: cancellationPolicy.getLastDetail().getCancellationPolicyName());
115                    edit.setReturnPolicyName(returnPolicy == null? null: returnPolicy.getLastDetail().getReturnPolicyName());
116                } else {
117                    addExecutionError(ExecutionErrors.EntityLockFailed.name());
118                }
119
120                result.setEntityLock(getEntityLockTransfer(vendorItem));
121            }
122        } else if(editMode.equals(EditMode.UPDATE)) {
123            var vendorItem = VendorItemLogic.getInstance().getVendorItemByUniversalSpecForUpdate(this, spec);
124
125            if(!hasExecutionErrors()) {
126                var vendorItemName = edit.getVendorItemName();
127                var duplicateVendorItem = vendorControl.getVendorItemByVendorPartyAndVendorItemName(vendorItem.getLastDetail().getVendorParty(), vendorItemName);
128
129                if(duplicateVendorItem == null || vendorItem.equals(duplicateVendorItem)) {
130                    String cancellationPolicyName = edit.getCancellationPolicyName();
131                    CancellationPolicy cancellationPolicy = null;
132
133                    if(cancellationPolicyName != null) {
134                        var cancellationPolicyControl = Session.getModelController(CancellationPolicyControl.class);
135                        CancellationKind cancellationKind = cancellationPolicyControl.getCancellationKindByName(CancellationKinds.VENDOR_CANCELLATION.name());
136
137                        cancellationPolicy = cancellationPolicyControl.getCancellationPolicyByName(cancellationKind, cancellationPolicyName);
138                    }
139
140                    if(cancellationPolicyName == null || cancellationPolicy != null) {
141                        String returnPolicyName = edit.getReturnPolicyName();
142                        ReturnPolicy returnPolicy = null;
143
144                        if(returnPolicyName != null) {
145                            var returnPolicyControl = Session.getModelController(ReturnPolicyControl.class);
146                            ReturnKind returnKind = returnPolicyControl.getReturnKindByName(ReturnKinds.VENDOR_RETURN.name());
147
148                            returnPolicy = returnPolicyControl.getReturnPolicyByName(returnKind, returnPolicyName);
149                        }
150
151                        if(returnPolicyName == null || returnPolicy != null) {
152                            if(lockEntityForUpdate(vendorItem)) {
153                                try {
154                                    VendorItemDetailValue vendorItemDetailValue = vendorControl.getVendorItemDetailValueForUpdate(vendorItem);
155
156                                    vendorItemDetailValue.setVendorItemName(edit.getVendorItemName());
157                                    vendorItemDetailValue.setDescription(edit.getDescription());
158                                    vendorItemDetailValue.setPriority(Integer.valueOf(edit.getPriority()));
159                                    vendorItemDetailValue.setCancellationPolicyPK(cancellationPolicy == null? null: cancellationPolicy.getPrimaryKey());
160                                    vendorItemDetailValue.setReturnPolicyPK(returnPolicy == null? null: returnPolicy.getPrimaryKey());
161
162                                    vendorControl.updateVendorItemFromValue(vendorItemDetailValue, getPartyPK());
163                                } finally {
164                                    unlockEntity(vendorItem);
165                                }
166                            } else {
167                                addExecutionError(ExecutionErrors.EntityLockStale.name());
168                            }
169                        } else {
170                            addExecutionError(ExecutionErrors.UnknownReturnPolicyName.name(), returnPolicyName);
171                        }
172                    } else {
173                        addExecutionError(ExecutionErrors.UnknownCancellationPolicyName.name(), cancellationPolicyName);
174                    }
175                } else {
176                    addExecutionError(ExecutionErrors.DuplicateVendorItemName.name(), vendorItemName);
177                }
178            }
179        }
180
181        return result;
182    }
183    
184}