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.PaymentMethodDescriptionEdit;
021import com.echothree.control.user.payment.common.form.EditPaymentMethodDescriptionForm;
022import com.echothree.control.user.payment.common.result.EditPaymentMethodDescriptionResult;
023import com.echothree.control.user.payment.common.result.PaymentResultFactory;
024import com.echothree.control.user.payment.common.spec.PaymentMethodDescriptionSpec;
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.PaymentMethodControl;
028import com.echothree.model.control.security.common.SecurityRoleGroups;
029import com.echothree.model.control.security.common.SecurityRoles;
030import com.echothree.model.data.payment.server.entity.PaymentMethod;
031import com.echothree.model.data.payment.server.entity.PaymentMethodDescription;
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 com.echothree.util.server.persistence.Session;
042import java.util.List;
043import javax.enterprise.context.Dependent;
044
045@Dependent
046public class EditPaymentMethodDescriptionCommand
047        extends BaseAbstractEditCommand<PaymentMethodDescriptionSpec, PaymentMethodDescriptionEdit, EditPaymentMethodDescriptionResult, PaymentMethodDescription, PaymentMethod> {
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.PaymentMethod.name(), SecurityRoles.Description.name())
058                    ))
059                ));
060
061        SPEC_FIELD_DEFINITIONS = List.of(
062                new FieldDefinition("PaymentMethodName", 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    /** Creates a new instance of EditPaymentMethodDescriptionCommand */
072    public EditPaymentMethodDescriptionCommand() {
073        super(COMMAND_SECURITY_DEFINITION, SPEC_FIELD_DEFINITIONS, EDIT_FIELD_DEFINITIONS);
074    }
075
076    @Override
077    public EditPaymentMethodDescriptionResult getResult() {
078        return PaymentResultFactory.getEditPaymentMethodDescriptionResult();
079    }
080
081    @Override
082    public PaymentMethodDescriptionEdit getEdit() {
083        return PaymentEditFactory.getPaymentMethodDescriptionEdit();
084    }
085
086    @Override
087    public PaymentMethodDescription getEntity(EditPaymentMethodDescriptionResult result) {
088        var paymentMethodControl = Session.getModelController(PaymentMethodControl.class);
089        PaymentMethodDescription paymentMethodDescription = null;
090        var paymentMethodName = spec.getPaymentMethodName();
091        var paymentMethod = paymentMethodControl.getPaymentMethodByName(paymentMethodName);
092
093        if(paymentMethod != null) {
094            var partyControl = Session.getModelController(PartyControl.class);
095            var languageIsoName = spec.getLanguageIsoName();
096            var language = partyControl.getLanguageByIsoName(languageIsoName);
097
098            if(language != null) {
099                if(editMode.equals(EditMode.LOCK) || editMode.equals(EditMode.ABANDON)) {
100                    paymentMethodDescription = paymentMethodControl.getPaymentMethodDescription(paymentMethod, language);
101                } else { // EditMode.UPDATE
102                    paymentMethodDescription = paymentMethodControl.getPaymentMethodDescriptionForUpdate(paymentMethod, language);
103                }
104
105                if(paymentMethodDescription == null) {
106                    addExecutionError(ExecutionErrors.UnknownPaymentMethodDescription.name(), paymentMethodName, languageIsoName);
107                }
108            } else {
109                addExecutionError(ExecutionErrors.UnknownLanguageIsoName.name(), languageIsoName);
110            }
111        } else {
112            addExecutionError(ExecutionErrors.UnknownPaymentMethodName.name(), paymentMethodName);
113        }
114
115        return paymentMethodDescription;
116    }
117
118    @Override
119    public PaymentMethod getLockEntity(PaymentMethodDescription paymentMethodDescription) {
120        return paymentMethodDescription.getPaymentMethod();
121    }
122
123    @Override
124    public void fillInResult(EditPaymentMethodDescriptionResult result, PaymentMethodDescription paymentMethodDescription) {
125        var paymentMethodControl = Session.getModelController(PaymentMethodControl.class);
126
127        result.setPaymentMethodDescription(paymentMethodControl.getPaymentMethodDescriptionTransfer(getUserVisit(), paymentMethodDescription));
128    }
129
130    @Override
131    public void doLock(PaymentMethodDescriptionEdit edit, PaymentMethodDescription paymentMethodDescription) {
132        edit.setDescription(paymentMethodDescription.getDescription());
133    }
134
135    @Override
136    public void doUpdate(PaymentMethodDescription paymentMethodDescription) {
137        var paymentMethodControl = Session.getModelController(PaymentMethodControl.class);
138        var paymentMethodDescriptionValue = paymentMethodControl.getPaymentMethodDescriptionValue(paymentMethodDescription);
139        paymentMethodDescriptionValue.setDescription(edit.getDescription());
140
141        paymentMethodControl.updatePaymentMethodDescriptionFromValue(paymentMethodDescriptionValue, getPartyPK());
142    }
143
144}