001// --------------------------------------------------------------------------------
002// Copyright 2002-2024 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.payment.server.entity.PaymentProcessorResultCodeDescription;
032import com.echothree.model.data.payment.server.entity.PaymentProcessorResultCodeDetail;
033import com.echothree.model.data.payment.server.value.PaymentProcessorResultCodeDescriptionValue;
034import com.echothree.model.data.payment.server.value.PaymentProcessorResultCodeDetailValue;
035import com.echothree.model.data.party.common.pk.PartyPK;
036import com.echothree.model.data.user.common.pk.UserVisitPK;
037import com.echothree.util.common.message.ExecutionErrors;
038import com.echothree.util.common.validation.FieldDefinition;
039import com.echothree.util.common.validation.FieldType;
040import com.echothree.util.server.control.BaseAbstractEditCommand;
041import com.echothree.util.server.control.CommandSecurityDefinition;
042import com.echothree.util.server.control.PartyTypeDefinition;
043import com.echothree.util.server.control.SecurityRoleDefinition;
044import com.echothree.util.server.persistence.Session;
045import java.util.Arrays;
046import java.util.Collections;
047import java.util.List;
048
049public class EditPaymentProcessorResultCodeCommand
050        extends BaseAbstractEditCommand<PaymentProcessorResultCodeUniversalSpec, PaymentProcessorResultCodeEdit, EditPaymentProcessorResultCodeResult, PaymentProcessorResultCode, PaymentProcessorResultCode> {
051    
052    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
053    private final static List<FieldDefinition> SPEC_FIELD_DEFINITIONS;
054    private final static List<FieldDefinition> EDIT_FIELD_DEFINITIONS;
055    
056    static {
057        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(Collections.unmodifiableList(Arrays.asList(
058                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
059                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), Collections.unmodifiableList(Arrays.asList(
060                        new SecurityRoleDefinition(SecurityRoleGroups.PaymentProcessorResultCode.name(), SecurityRoles.Edit.name())
061                        )))
062                )));
063        
064        SPEC_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
065                new FieldDefinition("PaymentProcessorResultCodeName", FieldType.ENTITY_NAME, false, null, null),
066                new FieldDefinition("EntityRef", FieldType.ENTITY_REF, false, null, null),
067                new FieldDefinition("Key", FieldType.KEY, false, null, null),
068                new FieldDefinition("Guid", FieldType.GUID, false, null, null),
069                new FieldDefinition("Ulid", FieldType.ULID, false, null, null)
070                ));
071        
072        EDIT_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
073                new FieldDefinition("PaymentProcessorResultCodeName", FieldType.ENTITY_NAME, true, null, null),
074                new FieldDefinition("IsDefault", FieldType.BOOLEAN, true, null, null),
075                new FieldDefinition("SortOrder", FieldType.SIGNED_INTEGER, true, null, null),
076                new FieldDefinition("Description", FieldType.STRING, false, 1L, 132L)
077                ));
078    }
079    
080    /** Creates a new instance of EditPaymentProcessorResultCodeCommand */
081    public EditPaymentProcessorResultCodeCommand(UserVisitPK userVisitPK, EditPaymentProcessorResultCodeForm form) {
082        super(userVisitPK, form, COMMAND_SECURITY_DEFINITION, SPEC_FIELD_DEFINITIONS, EDIT_FIELD_DEFINITIONS);
083    }
084    
085    @Override
086    public EditPaymentProcessorResultCodeResult getResult() {
087        return PaymentResultFactory.getEditPaymentProcessorResultCodeResult();
088    }
089    
090    @Override
091    public PaymentProcessorResultCodeEdit getEdit() {
092        return PaymentEditFactory.getPaymentProcessorResultCodeEdit();
093    }
094    
095    @Override
096    public PaymentProcessorResultCode getEntity(EditPaymentProcessorResultCodeResult result) {
097        return PaymentProcessorResultCodeLogic.getInstance().getPaymentProcessorResultCodeByUniversalSpec(this, spec, false, editModeToEntityPermission(editMode));
098    }
099    
100    @Override
101    public PaymentProcessorResultCode getLockEntity(PaymentProcessorResultCode paymentProcessorResultCode) {
102        return paymentProcessorResultCode;
103    }
104    
105    @Override
106    public void fillInResult(EditPaymentProcessorResultCodeResult result, PaymentProcessorResultCode paymentProcessorResultCode) {
107        var paymentProcessorResultCodeControl = Session.getModelController(PaymentProcessorResultCodeControl.class);
108        
109        result.setPaymentProcessorResultCode(paymentProcessorResultCodeControl.getPaymentProcessorResultCodeTransfer(getUserVisit(), paymentProcessorResultCode));
110    }
111    
112    @Override
113    public void doLock(PaymentProcessorResultCodeEdit edit, PaymentProcessorResultCode paymentProcessorResultCode) {
114        var paymentProcessorResultCodeControl = Session.getModelController(PaymentProcessorResultCodeControl.class);
115        PaymentProcessorResultCodeDescription paymentProcessorResultCodeDescription = paymentProcessorResultCodeControl.getPaymentProcessorResultCodeDescription(paymentProcessorResultCode, getPreferredLanguage());
116        PaymentProcessorResultCodeDetail paymentProcessorResultCodeDetail = paymentProcessorResultCode.getLastDetail();
117        
118        edit.setPaymentProcessorResultCodeName(paymentProcessorResultCodeDetail.getPaymentProcessorResultCodeName());
119        edit.setIsDefault(paymentProcessorResultCodeDetail.getIsDefault().toString());
120        edit.setSortOrder(paymentProcessorResultCodeDetail.getSortOrder().toString());
121
122        if(paymentProcessorResultCodeDescription != null) {
123            edit.setDescription(paymentProcessorResultCodeDescription.getDescription());
124        }
125    }
126        
127    @Override
128    public void canUpdate(PaymentProcessorResultCode paymentProcessorResultCode) {
129        var paymentProcessorResultCodeControl = Session.getModelController(PaymentProcessorResultCodeControl.class);
130        String paymentProcessorResultCodeName = edit.getPaymentProcessorResultCodeName();
131        PaymentProcessorResultCode duplicatePaymentProcessorResultCode = paymentProcessorResultCodeControl.getPaymentProcessorResultCodeByName(paymentProcessorResultCodeName);
132
133        if(duplicatePaymentProcessorResultCode != null && !paymentProcessorResultCode.equals(duplicatePaymentProcessorResultCode)) {
134            addExecutionError(ExecutionErrors.DuplicatePaymentProcessorResultCodeName.name(), paymentProcessorResultCodeName);
135        }
136    }
137    
138    @Override
139    public void doUpdate(PaymentProcessorResultCode paymentProcessorResultCode) {
140        var paymentProcessorResultCodeControl = Session.getModelController(PaymentProcessorResultCodeControl.class);
141        var partyPK = getPartyPK();
142        PaymentProcessorResultCodeDetailValue paymentProcessorResultCodeDetailValue = paymentProcessorResultCodeControl.getPaymentProcessorResultCodeDetailValueForUpdate(paymentProcessorResultCode);
143        PaymentProcessorResultCodeDescription paymentProcessorResultCodeDescription = paymentProcessorResultCodeControl.getPaymentProcessorResultCodeDescriptionForUpdate(paymentProcessorResultCode, getPreferredLanguage());
144        String description = edit.getDescription();
145
146        paymentProcessorResultCodeDetailValue.setPaymentProcessorResultCodeName(edit.getPaymentProcessorResultCodeName());
147        paymentProcessorResultCodeDetailValue.setIsDefault(Boolean.valueOf(edit.getIsDefault()));
148        paymentProcessorResultCodeDetailValue.setSortOrder(Integer.valueOf(edit.getSortOrder()));
149
150        paymentProcessorResultCodeControl.updatePaymentProcessorResultCodeFromValue(paymentProcessorResultCodeDetailValue, partyPK);
151
152        if(paymentProcessorResultCodeDescription == null && description != null) {
153            paymentProcessorResultCodeControl.createPaymentProcessorResultCodeDescription(paymentProcessorResultCode, getPreferredLanguage(), description, partyPK);
154        } else if(paymentProcessorResultCodeDescription != null && description == null) {
155            paymentProcessorResultCodeControl.deletePaymentProcessorResultCodeDescription(paymentProcessorResultCodeDescription, partyPK);
156        } else if(paymentProcessorResultCodeDescription != null && description != null) {
157            PaymentProcessorResultCodeDescriptionValue paymentProcessorResultCodeDescriptionValue = paymentProcessorResultCodeControl.getPaymentProcessorResultCodeDescriptionValue(paymentProcessorResultCodeDescription);
158
159            paymentProcessorResultCodeDescriptionValue.setDescription(description);
160            paymentProcessorResultCodeControl.updatePaymentProcessorResultCodeDescriptionFromValue(paymentProcessorResultCodeDescriptionValue, partyPK);
161        }
162    }
163    
164}