001// --------------------------------------------------------------------------------
002// Copyright 2002-2026 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.payment.server.command;
018
019import com.echothree.control.user.payment.common.edit.PaymentEditFactory;
020import com.echothree.control.user.payment.common.edit.PaymentProcessorEdit;
021import com.echothree.control.user.payment.common.form.EditPaymentProcessorForm;
022import com.echothree.control.user.payment.common.result.EditPaymentProcessorResult;
023import com.echothree.control.user.payment.common.result.PaymentResultFactory;
024import com.echothree.control.user.payment.common.spec.PaymentProcessorSpec;
025import com.echothree.model.control.party.common.PartyTypes;
026import com.echothree.model.control.payment.server.control.PaymentProcessorControl;
027import com.echothree.model.control.security.common.SecurityRoleGroups;
028import com.echothree.model.control.security.common.SecurityRoles;
029import com.echothree.model.data.payment.server.entity.PaymentProcessor;
030import com.echothree.model.data.user.common.pk.UserVisitPK;
031import com.echothree.util.common.command.EditMode;
032import com.echothree.util.common.message.ExecutionErrors;
033import com.echothree.util.common.validation.FieldDefinition;
034import com.echothree.util.common.validation.FieldType;
035import com.echothree.util.server.control.BaseAbstractEditCommand;
036import com.echothree.util.server.control.CommandSecurityDefinition;
037import com.echothree.util.server.control.PartyTypeDefinition;
038import com.echothree.util.server.control.SecurityRoleDefinition;
039import com.echothree.util.server.persistence.Session;
040import java.util.List;
041import javax.enterprise.context.Dependent;
042
043@Dependent
044public class EditPaymentProcessorCommand
045        extends BaseAbstractEditCommand<PaymentProcessorSpec, PaymentProcessorEdit, EditPaymentProcessorResult, PaymentProcessor, PaymentProcessor> {
046    
047    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
048    private final static List<FieldDefinition> SPEC_FIELD_DEFINITIONS;
049    private final static List<FieldDefinition> EDIT_FIELD_DEFINITIONS;
050    
051    static {
052        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(List.of(
053                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
054                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
055                    new SecurityRoleDefinition(SecurityRoleGroups.PaymentProcessor.name(), SecurityRoles.Edit.name())
056                    ))
057                ));
058
059        SPEC_FIELD_DEFINITIONS = List.of(
060                new FieldDefinition("PaymentProcessorName", FieldType.ENTITY_NAME, true, null, null)
061                );
062
063        EDIT_FIELD_DEFINITIONS = List.of(
064                new FieldDefinition("PaymentProcessorName", FieldType.ENTITY_NAME, true, null, null),
065                new FieldDefinition("IsDefault", FieldType.BOOLEAN, true, null, null),
066                new FieldDefinition("SortOrder", FieldType.SIGNED_INTEGER, true, null, null),
067                new FieldDefinition("Description", FieldType.STRING, false, 1L, 132L)
068                );
069    }
070    
071    /** Creates a new instance of EditPaymentProcessorCommand */
072    public EditPaymentProcessorCommand() {
073        super(COMMAND_SECURITY_DEFINITION, SPEC_FIELD_DEFINITIONS, EDIT_FIELD_DEFINITIONS);
074    }
075    
076    @Override
077    public EditPaymentProcessorResult getResult() {
078        return PaymentResultFactory.getEditPaymentProcessorResult();
079    }
080
081    @Override
082    public PaymentProcessorEdit getEdit() {
083        return PaymentEditFactory.getPaymentProcessorEdit();
084    }
085
086    @Override
087    public PaymentProcessor getEntity(EditPaymentProcessorResult result) {
088        var paymentProcessorControl = Session.getModelController(PaymentProcessorControl.class);
089        PaymentProcessor paymentProcessor;
090        var paymentProcessorName = spec.getPaymentProcessorName();
091
092        if(editMode.equals(EditMode.LOCK) || editMode.equals(EditMode.ABANDON)) {
093            paymentProcessor = paymentProcessorControl.getPaymentProcessorByName(paymentProcessorName);
094        } else { // EditMode.UPDATE
095            paymentProcessor = paymentProcessorControl.getPaymentProcessorByNameForUpdate(paymentProcessorName);
096        }
097
098        if(paymentProcessor != null) {
099            result.setPaymentProcessor(paymentProcessorControl.getPaymentProcessorTransfer(getUserVisit(), paymentProcessor));
100        } else {
101            addExecutionError(ExecutionErrors.UnknownPaymentProcessorName.name(), paymentProcessorName);
102        }
103
104        return paymentProcessor;
105    }
106
107    @Override
108    public PaymentProcessor getLockEntity(PaymentProcessor paymentProcessor) {
109        return paymentProcessor;
110    }
111
112    @Override
113    public void fillInResult(EditPaymentProcessorResult result, PaymentProcessor paymentProcessor) {
114        var paymentProcessorControl = Session.getModelController(PaymentProcessorControl.class);
115
116        result.setPaymentProcessor(paymentProcessorControl.getPaymentProcessorTransfer(getUserVisit(), paymentProcessor));
117    }
118
119    @Override
120    public void doLock(PaymentProcessorEdit edit, PaymentProcessor paymentProcessor) {
121        var paymentProcessorControl = Session.getModelController(PaymentProcessorControl.class);
122        var paymentProcessorDescription = paymentProcessorControl.getPaymentProcessorDescription(paymentProcessor, getPreferredLanguage());
123        var paymentProcessorDetail = paymentProcessor.getLastDetail();
124
125        edit.setPaymentProcessorName(paymentProcessorDetail.getPaymentProcessorName());
126        edit.setIsDefault(paymentProcessorDetail.getIsDefault().toString());
127        edit.setSortOrder(paymentProcessorDetail.getSortOrder().toString());
128
129        if(paymentProcessorDescription != null) {
130            edit.setDescription(paymentProcessorDescription.getDescription());
131        }
132    }
133
134    @Override
135    public void canUpdate(PaymentProcessor paymentProcessor) {
136        var paymentProcessorControl = Session.getModelController(PaymentProcessorControl.class);
137        var paymentProcessorName = edit.getPaymentProcessorName();
138        var duplicatePaymentProcessor = paymentProcessorControl.getPaymentProcessorByName(paymentProcessorName);
139
140        if(duplicatePaymentProcessor != null && !paymentProcessor.equals(duplicatePaymentProcessor)) {
141            addExecutionError(ExecutionErrors.DuplicatePaymentProcessorName.name(), paymentProcessorName);
142        }
143    }
144
145    @Override
146    public void doUpdate(PaymentProcessor paymentProcessor) {
147        var paymentProcessorControl = Session.getModelController(PaymentProcessorControl.class);
148        var partyPK = getPartyPK();
149        var paymentProcessorDetailValue = paymentProcessorControl.getPaymentProcessorDetailValueForUpdate(paymentProcessor);
150        var paymentProcessorDescription = paymentProcessorControl.getPaymentProcessorDescriptionForUpdate(paymentProcessor, getPreferredLanguage());
151        var description = edit.getDescription();
152
153        paymentProcessorDetailValue.setPaymentProcessorName(edit.getPaymentProcessorName());
154        paymentProcessorDetailValue.setIsDefault(Boolean.valueOf(edit.getIsDefault()));
155        paymentProcessorDetailValue.setSortOrder(Integer.valueOf(edit.getSortOrder()));
156
157        paymentProcessorControl.updatePaymentProcessorFromValue(paymentProcessorDetailValue, partyPK);
158
159        if(paymentProcessorDescription == null && description != null) {
160            paymentProcessorControl.createPaymentProcessorDescription(paymentProcessor, getPreferredLanguage(), description, partyPK);
161        } else if(paymentProcessorDescription != null && description == null) {
162            paymentProcessorControl.deletePaymentProcessorDescription(paymentProcessorDescription, partyPK);
163        } else if(paymentProcessorDescription != null && description != null) {
164            var paymentProcessorDescriptionValue = paymentProcessorControl.getPaymentProcessorDescriptionValue(paymentProcessorDescription);
165
166            paymentProcessorDescriptionValue.setDescription(description);
167            paymentProcessorControl.updatePaymentProcessorDescriptionFromValue(paymentProcessorDescriptionValue, partyPK);
168        }
169    }
170
171}