001// --------------------------------------------------------------------------------
002// Copyright 2002-2025 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.form.GetPaymentMethodChoicesForm;
020import com.echothree.control.user.payment.common.result.PaymentResultFactory;
021import com.echothree.model.control.party.common.PartyTypes;
022import com.echothree.model.control.payment.server.control.PaymentMethodControl;
023import com.echothree.model.control.payment.server.logic.PaymentMethodTypeLogic;
024import com.echothree.model.control.security.common.SecurityRoleGroups;
025import com.echothree.model.control.security.common.SecurityRoles;
026import com.echothree.model.data.user.common.pk.UserVisitPK;
027import com.echothree.util.common.command.BaseResult;
028import com.echothree.util.common.validation.FieldDefinition;
029import com.echothree.util.common.validation.FieldType;
030import com.echothree.util.server.control.BaseSimpleCommand;
031import com.echothree.util.server.control.CommandSecurityDefinition;
032import com.echothree.util.server.control.PartyTypeDefinition;
033import com.echothree.util.server.control.SecurityRoleDefinition;
034import com.echothree.util.server.persistence.Session;
035import java.util.Arrays;
036import java.util.Collections;
037import java.util.List;
038import javax.enterprise.context.RequestScoped;
039
040@RequestScoped
041public class GetPaymentMethodChoicesCommand
042        extends BaseSimpleCommand<GetPaymentMethodChoicesForm> {
043    
044    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
045    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
046    
047    static {
048        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(Collections.unmodifiableList(Arrays.asList(
049                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), Collections.unmodifiableList(Arrays.asList(
050                        new SecurityRoleDefinition(SecurityRoleGroups.PaymentMethod.name(), SecurityRoles.Choices.name())
051                        )))
052                )));
053
054        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
055                new FieldDefinition("PaymentMethodTypeName", FieldType.ENTITY_NAME, false, null, null),
056                new FieldDefinition("DefaultPaymentMethodChoice", FieldType.ENTITY_NAME, false, null, null),
057                new FieldDefinition("AllowNullChoice", FieldType.BOOLEAN, true, null, null)
058                ));
059    }
060    
061    /** Creates a new instance of GetPaymentMethodChoicesCommand */
062    public GetPaymentMethodChoicesCommand() {
063        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
064    }
065    
066    @Override
067    protected BaseResult execute() {
068        var paymentMethodControl = Session.getModelController(PaymentMethodControl.class);
069        var result = PaymentResultFactory.getGetPaymentMethodChoicesResult();
070        var paymentMethodTypeName = form.getPaymentMethodTypeName();
071        var paymentMethodType = paymentMethodTypeName == null ? null : PaymentMethodTypeLogic.getInstance().getPaymentMethodTypeByName(this, paymentMethodTypeName);
072
073        if(!hasExecutionErrors()) {
074            var defaultPaymentMethodChoice = form.getDefaultPaymentMethodChoice();
075            var allowNullChoice = Boolean.parseBoolean(form.getAllowNullChoice());
076
077            if(paymentMethodType == null) {
078                result.setPaymentMethodChoices(paymentMethodControl.getPaymentMethodChoices(defaultPaymentMethodChoice, getPreferredLanguage(), allowNullChoice));
079            } else {
080                result.setPaymentMethodChoices(paymentMethodControl.getPaymentMethodChoicesByPaymentMethodType(defaultPaymentMethodChoice, getPreferredLanguage(),
081                        allowNullChoice, paymentMethodType));
082            }
083        }
084        
085        return result;
086    }
087    
088}