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.PaymentProcessorResultCodeEdit;
021import com.echothree.control.user.payment.common.form.EditPaymentProcessorResultCodeForm;
022import com.echothree.control.user.payment.common.result.PaymentResultFactory;
023import com.echothree.control.user.payment.common.result.EditPaymentProcessorResultCodeResult;
024import com.echothree.control.user.payment.common.spec.PaymentProcessorResultCodeUniversalSpec;
025import com.echothree.model.control.payment.server.control.PaymentProcessorResultCodeControl;
026import com.echothree.model.control.payment.server.logic.PaymentProcessorResultCodeLogic;
027import com.echothree.model.control.party.common.PartyTypes;
028import com.echothree.model.control.security.common.SecurityRoleGroups;
029import com.echothree.model.control.security.common.SecurityRoles;
030import com.echothree.model.data.payment.server.entity.PaymentProcessorResultCode;
031import com.echothree.model.data.user.common.pk.UserVisitPK;
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 EditPaymentProcessorResultCodeCommand
045        extends BaseAbstractEditCommand<PaymentProcessorResultCodeUniversalSpec, PaymentProcessorResultCodeEdit, EditPaymentProcessorResultCodeResult, PaymentProcessorResultCode, PaymentProcessorResultCode> {
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.PaymentProcessorResultCode.name(), SecurityRoles.Edit.name())
056                        ))
057                ));
058        
059        SPEC_FIELD_DEFINITIONS = List.of(
060                new FieldDefinition("PaymentProcessorResultCodeName", FieldType.ENTITY_NAME, false, null, null),
061                new FieldDefinition("EntityRef", FieldType.ENTITY_REF, false, null, null),
062                new FieldDefinition("Uuid", FieldType.UUID, false, null, null)
063                );
064        
065        EDIT_FIELD_DEFINITIONS = List.of(
066                new FieldDefinition("PaymentProcessorResultCodeName", 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 EditPaymentProcessorResultCodeCommand */
074    public EditPaymentProcessorResultCodeCommand() {
075        super(COMMAND_SECURITY_DEFINITION, SPEC_FIELD_DEFINITIONS, EDIT_FIELD_DEFINITIONS);
076    }
077    
078    @Override
079    public EditPaymentProcessorResultCodeResult getResult() {
080        return PaymentResultFactory.getEditPaymentProcessorResultCodeResult();
081    }
082    
083    @Override
084    public PaymentProcessorResultCodeEdit getEdit() {
085        return PaymentEditFactory.getPaymentProcessorResultCodeEdit();
086    }
087    
088    @Override
089    public PaymentProcessorResultCode getEntity(EditPaymentProcessorResultCodeResult result) {
090        return PaymentProcessorResultCodeLogic.getInstance().getPaymentProcessorResultCodeByUniversalSpec(this, spec, false, editModeToEntityPermission(editMode));
091    }
092    
093    @Override
094    public PaymentProcessorResultCode getLockEntity(PaymentProcessorResultCode paymentProcessorResultCode) {
095        return paymentProcessorResultCode;
096    }
097    
098    @Override
099    public void fillInResult(EditPaymentProcessorResultCodeResult result, PaymentProcessorResultCode paymentProcessorResultCode) {
100        var paymentProcessorResultCodeControl = Session.getModelController(PaymentProcessorResultCodeControl.class);
101        
102        result.setPaymentProcessorResultCode(paymentProcessorResultCodeControl.getPaymentProcessorResultCodeTransfer(getUserVisit(), paymentProcessorResultCode));
103    }
104    
105    @Override
106    public void doLock(PaymentProcessorResultCodeEdit edit, PaymentProcessorResultCode paymentProcessorResultCode) {
107        var paymentProcessorResultCodeControl = Session.getModelController(PaymentProcessorResultCodeControl.class);
108        var paymentProcessorResultCodeDescription = paymentProcessorResultCodeControl.getPaymentProcessorResultCodeDescription(paymentProcessorResultCode, getPreferredLanguage());
109        var paymentProcessorResultCodeDetail = paymentProcessorResultCode.getLastDetail();
110        
111        edit.setPaymentProcessorResultCodeName(paymentProcessorResultCodeDetail.getPaymentProcessorResultCodeName());
112        edit.setIsDefault(paymentProcessorResultCodeDetail.getIsDefault().toString());
113        edit.setSortOrder(paymentProcessorResultCodeDetail.getSortOrder().toString());
114
115        if(paymentProcessorResultCodeDescription != null) {
116            edit.setDescription(paymentProcessorResultCodeDescription.getDescription());
117        }
118    }
119        
120    @Override
121    public void canUpdate(PaymentProcessorResultCode paymentProcessorResultCode) {
122        var paymentProcessorResultCodeControl = Session.getModelController(PaymentProcessorResultCodeControl.class);
123        var paymentProcessorResultCodeName = edit.getPaymentProcessorResultCodeName();
124        var duplicatePaymentProcessorResultCode = paymentProcessorResultCodeControl.getPaymentProcessorResultCodeByName(paymentProcessorResultCodeName);
125
126        if(duplicatePaymentProcessorResultCode != null && !paymentProcessorResultCode.equals(duplicatePaymentProcessorResultCode)) {
127            addExecutionError(ExecutionErrors.DuplicatePaymentProcessorResultCodeName.name(), paymentProcessorResultCodeName);
128        }
129    }
130    
131    @Override
132    public void doUpdate(PaymentProcessorResultCode paymentProcessorResultCode) {
133        var paymentProcessorResultCodeControl = Session.getModelController(PaymentProcessorResultCodeControl.class);
134        var partyPK = getPartyPK();
135        var paymentProcessorResultCodeDetailValue = paymentProcessorResultCodeControl.getPaymentProcessorResultCodeDetailValueForUpdate(paymentProcessorResultCode);
136        var paymentProcessorResultCodeDescription = paymentProcessorResultCodeControl.getPaymentProcessorResultCodeDescriptionForUpdate(paymentProcessorResultCode, getPreferredLanguage());
137        var description = edit.getDescription();
138
139        paymentProcessorResultCodeDetailValue.setPaymentProcessorResultCodeName(edit.getPaymentProcessorResultCodeName());
140        paymentProcessorResultCodeDetailValue.setIsDefault(Boolean.valueOf(edit.getIsDefault()));
141        paymentProcessorResultCodeDetailValue.setSortOrder(Integer.valueOf(edit.getSortOrder()));
142
143        paymentProcessorResultCodeControl.updatePaymentProcessorResultCodeFromValue(paymentProcessorResultCodeDetailValue, partyPK);
144
145        if(paymentProcessorResultCodeDescription == null && description != null) {
146            paymentProcessorResultCodeControl.createPaymentProcessorResultCodeDescription(paymentProcessorResultCode, getPreferredLanguage(), description, partyPK);
147        } else if(paymentProcessorResultCodeDescription != null && description == null) {
148            paymentProcessorResultCodeControl.deletePaymentProcessorResultCodeDescription(paymentProcessorResultCodeDescription, partyPK);
149        } else if(paymentProcessorResultCodeDescription != null && description != null) {
150            var paymentProcessorResultCodeDescriptionValue = paymentProcessorResultCodeControl.getPaymentProcessorResultCodeDescriptionValue(paymentProcessorResultCodeDescription);
151
152            paymentProcessorResultCodeDescriptionValue.setDescription(description);
153            paymentProcessorResultCodeControl.updatePaymentProcessorResultCodeDescriptionFromValue(paymentProcessorResultCodeDescriptionValue, partyPK);
154        }
155    }
156    
157}