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.model.control.payment.server.logic;
018
019import com.echothree.control.user.payment.common.spec.PaymentProcessorResultCodeUniversalSpec;
020import com.echothree.model.control.payment.common.exception.DuplicatePaymentProcessorResultCodeNameException;
021import com.echothree.model.control.payment.common.exception.UnknownPaymentProcessorResultCodeNameException;
022import com.echothree.model.control.payment.common.exception.UnknownDefaultPaymentProcessorResultCodeException;
023import com.echothree.model.control.payment.server.control.PaymentProcessorResultCodeControl;
024import com.echothree.model.control.core.common.ComponentVendors;
025import com.echothree.model.control.core.common.EntityTypes;
026import com.echothree.model.control.core.common.exception.InvalidParameterCountException;
027import com.echothree.model.control.core.server.logic.EntityInstanceLogic;
028import com.echothree.model.data.payment.server.entity.PaymentProcessorResultCode;
029import com.echothree.model.data.core.server.entity.EntityInstance;
030import com.echothree.model.data.party.server.entity.Language;
031import com.echothree.util.common.message.ExecutionErrors;
032import com.echothree.util.common.persistence.BasePK;
033import com.echothree.util.server.control.BaseLogic;
034import com.echothree.util.server.message.ExecutionErrorAccumulator;
035import com.echothree.util.server.persistence.EntityPermission;
036import com.echothree.util.server.persistence.Session;
037
038public class PaymentProcessorResultCodeLogic
039    extends BaseLogic {
040    
041    private PaymentProcessorResultCodeLogic() {
042        super();
043    }
044    
045    private static class PaymentProcessorResultCodeLogicHolder {
046        static PaymentProcessorResultCodeLogic instance = new PaymentProcessorResultCodeLogic();
047    }
048    
049    public static PaymentProcessorResultCodeLogic getInstance() {
050        return PaymentProcessorResultCodeLogicHolder.instance;
051    }
052
053    public PaymentProcessorResultCode createPaymentProcessorResultCode(final ExecutionErrorAccumulator eea, final String paymentProcessorResultCodeName,
054            final Boolean isDefault, final Integer sortOrder, final Language language, final String description,
055            final BasePK createdBy) {
056        var paymentProcessorResultCodeControl = Session.getModelController(PaymentProcessorResultCodeControl.class);
057        PaymentProcessorResultCode paymentProcessorResultCode = paymentProcessorResultCodeControl.getPaymentProcessorResultCodeByName(paymentProcessorResultCodeName);
058
059        if(paymentProcessorResultCode == null) {
060            paymentProcessorResultCode = paymentProcessorResultCodeControl.createPaymentProcessorResultCode(paymentProcessorResultCodeName, isDefault, sortOrder, createdBy);
061
062            if(description != null) {
063                paymentProcessorResultCodeControl.createPaymentProcessorResultCodeDescription(paymentProcessorResultCode, language, description, createdBy);
064            }
065        } else {
066            handleExecutionError(DuplicatePaymentProcessorResultCodeNameException.class, eea, ExecutionErrors.DuplicatePaymentProcessorResultCodeName.name(), paymentProcessorResultCodeName);
067        }
068
069        return paymentProcessorResultCode;
070    }
071
072    public PaymentProcessorResultCode getPaymentProcessorResultCodeByName(final ExecutionErrorAccumulator eea, final String paymentProcessorResultCodeName,
073            final EntityPermission entityPermission) {
074        var paymentProcessorResultCodeControl = Session.getModelController(PaymentProcessorResultCodeControl.class);
075        PaymentProcessorResultCode paymentProcessorResultCode = paymentProcessorResultCodeControl.getPaymentProcessorResultCodeByName(paymentProcessorResultCodeName, entityPermission);
076
077        if(paymentProcessorResultCode == null) {
078            handleExecutionError(UnknownPaymentProcessorResultCodeNameException.class, eea, ExecutionErrors.UnknownPaymentProcessorResultCodeName.name(), paymentProcessorResultCodeName);
079        }
080
081        return paymentProcessorResultCode;
082    }
083
084    public PaymentProcessorResultCode getPaymentProcessorResultCodeByName(final ExecutionErrorAccumulator eea, final String paymentProcessorResultCodeName) {
085        return getPaymentProcessorResultCodeByName(eea, paymentProcessorResultCodeName, EntityPermission.READ_ONLY);
086    }
087
088    public PaymentProcessorResultCode getPaymentProcessorResultCodeByNameForUpdate(final ExecutionErrorAccumulator eea, final String paymentProcessorResultCodeName) {
089        return getPaymentProcessorResultCodeByName(eea, paymentProcessorResultCodeName, EntityPermission.READ_WRITE);
090    }
091
092    public PaymentProcessorResultCode getPaymentProcessorResultCodeByUniversalSpec(final ExecutionErrorAccumulator eea,
093            final PaymentProcessorResultCodeUniversalSpec universalSpec, boolean allowDefault, final EntityPermission entityPermission) {
094        PaymentProcessorResultCode paymentProcessorResultCode = null;
095        var paymentProcessorResultCodeControl = Session.getModelController(PaymentProcessorResultCodeControl.class);
096        String paymentProcessorResultCodeName = universalSpec.getPaymentProcessorResultCodeName();
097        var parameterCount = (paymentProcessorResultCodeName == null ? 0 : 1) + EntityInstanceLogic.getInstance().countPossibleEntitySpecs(universalSpec);
098
099        switch(parameterCount) {
100            case 0:
101                if(allowDefault) {
102                    paymentProcessorResultCode = paymentProcessorResultCodeControl.getDefaultPaymentProcessorResultCode(entityPermission);
103
104                    if(paymentProcessorResultCode == null) {
105                        handleExecutionError(UnknownDefaultPaymentProcessorResultCodeException.class, eea, ExecutionErrors.UnknownDefaultPaymentProcessorResultCode.name());
106                    }
107                } else {
108                    handleExecutionError(InvalidParameterCountException.class, eea, ExecutionErrors.InvalidParameterCount.name());
109                }
110                break;
111            case 1:
112                if(paymentProcessorResultCodeName == null) {
113                    var entityInstance = EntityInstanceLogic.getInstance().getEntityInstance(eea, universalSpec,
114                            ComponentVendors.ECHO_THREE.name(), EntityTypes.PaymentProcessorResultCode.name());
115
116                    if(!eea.hasExecutionErrors()) {
117                        paymentProcessorResultCode = paymentProcessorResultCodeControl.getPaymentProcessorResultCodeByEntityInstance(entityInstance, entityPermission);
118                    }
119                } else {
120                    paymentProcessorResultCode = getPaymentProcessorResultCodeByName(eea, paymentProcessorResultCodeName, entityPermission);
121                }
122                break;
123            default:
124                handleExecutionError(InvalidParameterCountException.class, eea, ExecutionErrors.InvalidParameterCount.name());
125                break;
126        }
127
128        return paymentProcessorResultCode;
129    }
130
131    public PaymentProcessorResultCode getPaymentProcessorResultCodeByUniversalSpec(final ExecutionErrorAccumulator eea,
132            final PaymentProcessorResultCodeUniversalSpec universalSpec, boolean allowDefault) {
133        return getPaymentProcessorResultCodeByUniversalSpec(eea, universalSpec, allowDefault, EntityPermission.READ_ONLY);
134    }
135
136    public PaymentProcessorResultCode getPaymentProcessorResultCodeByUniversalSpecForUpdate(final ExecutionErrorAccumulator eea,
137            final PaymentProcessorResultCodeUniversalSpec universalSpec, boolean allowDefault) {
138        return getPaymentProcessorResultCodeByUniversalSpec(eea, universalSpec, allowDefault, EntityPermission.READ_WRITE);
139    }
140
141    public void deletePaymentProcessorResultCode(final ExecutionErrorAccumulator eea, final PaymentProcessorResultCode paymentProcessorResultCode,
142            final BasePK deletedBy) {
143        var paymentProcessorResultCodeControl = Session.getModelController(PaymentProcessorResultCodeControl.class);
144
145        paymentProcessorResultCodeControl.deletePaymentProcessorResultCode(paymentProcessorResultCode, deletedBy);
146    }
147}