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