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.PaymentProcessorDescriptionEdit;
021import com.echothree.control.user.payment.common.form.EditPaymentProcessorDescriptionForm;
022import com.echothree.control.user.payment.common.result.EditPaymentProcessorDescriptionResult;
023import com.echothree.control.user.payment.common.result.PaymentResultFactory;
024import com.echothree.control.user.payment.common.spec.PaymentProcessorDescriptionSpec;
025import com.echothree.model.control.party.common.PartyTypes;
026import com.echothree.model.control.party.server.control.PartyControl;
027import com.echothree.model.control.payment.server.control.PaymentProcessorControl;
028import com.echothree.model.control.security.common.SecurityRoleGroups;
029import com.echothree.model.control.security.common.SecurityRoles;
030import com.echothree.model.data.payment.server.entity.PaymentProcessor;
031import com.echothree.model.data.payment.server.entity.PaymentProcessorDescription;
032import com.echothree.model.data.user.common.pk.UserVisitPK;
033import com.echothree.util.common.command.EditMode;
034import com.echothree.util.common.message.ExecutionErrors;
035import com.echothree.util.common.validation.FieldDefinition;
036import com.echothree.util.common.validation.FieldType;
037import com.echothree.util.server.control.BaseAbstractEditCommand;
038import com.echothree.util.server.control.CommandSecurityDefinition;
039import com.echothree.util.server.control.PartyTypeDefinition;
040import com.echothree.util.server.control.SecurityRoleDefinition;
041import java.util.List;
042import javax.enterprise.context.Dependent;
043import javax.inject.Inject;
044
045@Dependent
046public class EditPaymentProcessorDescriptionCommand
047        extends BaseAbstractEditCommand<PaymentProcessorDescriptionSpec, PaymentProcessorDescriptionEdit, EditPaymentProcessorDescriptionResult, PaymentProcessorDescription, 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(List.of(
055                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
056                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
057                        new SecurityRoleDefinition(SecurityRoleGroups.PaymentProcessor.name(), SecurityRoles.Description.name())
058                ))
059        ));
060
061        SPEC_FIELD_DEFINITIONS = List.of(
062                new FieldDefinition("PaymentProcessorName", FieldType.ENTITY_NAME, true, null, null),
063                new FieldDefinition("LanguageIsoName", FieldType.ENTITY_NAME, true, null, null)
064        );
065
066        EDIT_FIELD_DEFINITIONS = List.of(
067                new FieldDefinition("Description", FieldType.STRING, true, 1L, 132L)
068        );
069    }
070
071    @Inject
072    PartyControl partyControl;
073
074    @Inject
075    PaymentProcessorControl paymentProcessorControl;
076
077    /** Creates a new instance of EditPaymentProcessorDescriptionCommand */
078    public EditPaymentProcessorDescriptionCommand() {
079        super(COMMAND_SECURITY_DEFINITION, SPEC_FIELD_DEFINITIONS, EDIT_FIELD_DEFINITIONS);
080    }
081
082    @Override
083    public EditPaymentProcessorDescriptionResult getResult() {
084        return PaymentResultFactory.getEditPaymentProcessorDescriptionResult();
085    }
086
087    @Override
088    public PaymentProcessorDescriptionEdit getEdit() {
089        return PaymentEditFactory.getPaymentProcessorDescriptionEdit();
090    }
091
092    @Override
093    public PaymentProcessorDescription getEntity(EditPaymentProcessorDescriptionResult result) {
094        PaymentProcessorDescription paymentProcessorDescription = null;
095        var paymentProcessorName = spec.getPaymentProcessorName();
096        var paymentProcessor = paymentProcessorControl.getPaymentProcessorByName(paymentProcessorName);
097
098        if(paymentProcessor != null) {
099            var languageIsoName = spec.getLanguageIsoName();
100            var language = partyControl.getLanguageByIsoName(languageIsoName);
101
102            if(language != null) {
103                if(editMode.equals(EditMode.LOCK) || editMode.equals(EditMode.ABANDON)) {
104                    paymentProcessorDescription = paymentProcessorControl.getPaymentProcessorDescription(paymentProcessor, language);
105                } else { // EditMode.UPDATE
106                    paymentProcessorDescription = paymentProcessorControl.getPaymentProcessorDescriptionForUpdate(paymentProcessor, language);
107                }
108
109                if(paymentProcessorDescription == null) {
110                    addExecutionError(ExecutionErrors.UnknownPaymentProcessorDescription.name(), paymentProcessorName, languageIsoName);
111                }
112            } else {
113                addExecutionError(ExecutionErrors.UnknownLanguageIsoName.name(), languageIsoName);
114            }
115        } else {
116            addExecutionError(ExecutionErrors.UnknownPaymentProcessorName.name(), paymentProcessorName);
117        }
118
119        return paymentProcessorDescription;
120    }
121
122    @Override
123    public PaymentProcessor getLockEntity(PaymentProcessorDescription paymentProcessorDescription) {
124        return paymentProcessorDescription.getPaymentProcessor();
125    }
126
127    @Override
128    public void fillInResult(EditPaymentProcessorDescriptionResult result, PaymentProcessorDescription paymentProcessorDescription) {
129        result.setPaymentProcessorDescription(paymentProcessorControl.getPaymentProcessorDescriptionTransfer(getUserVisit(), paymentProcessorDescription));
130    }
131
132    @Override
133    public void doLock(PaymentProcessorDescriptionEdit edit, PaymentProcessorDescription paymentProcessorDescription) {
134        edit.setDescription(paymentProcessorDescription.getDescription());
135    }
136
137    @Override
138    public void doUpdate(PaymentProcessorDescription paymentProcessorDescription) {
139        var paymentProcessorDescriptionValue = paymentProcessorControl.getPaymentProcessorDescriptionValue(paymentProcessorDescription);
140        paymentProcessorDescriptionValue.setDescription(edit.getDescription());
141
142        paymentProcessorControl.updatePaymentProcessorDescriptionFromValue(paymentProcessorDescriptionValue, getPartyPK());
143    }
144
145}