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.form.GetPartyPaymentMethodChoicesForm;
020import com.echothree.control.user.payment.common.result.PaymentResultFactory;
021import com.echothree.model.control.party.common.PartyTypes;
022import com.echothree.model.control.party.server.control.PartyControl;
023import com.echothree.model.control.payment.server.control.PartyPaymentMethodControl;
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.message.ExecutionErrors;
029import com.echothree.util.common.validation.FieldDefinition;
030import com.echothree.util.common.validation.FieldType;
031import com.echothree.util.server.control.BaseSimpleCommand;
032import com.echothree.util.server.control.CommandSecurityDefinition;
033import com.echothree.util.server.control.PartyTypeDefinition;
034import com.echothree.util.server.control.SecurityRoleDefinition;
035import com.echothree.util.server.persistence.Session;
036import java.util.List;
037import javax.enterprise.context.Dependent;
038
039@Dependent
040public class GetPartyPaymentMethodChoicesCommand
041        extends BaseSimpleCommand<GetPartyPaymentMethodChoicesForm> {
042    
043    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
044    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
045    
046    static {
047        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(List.of(
048                new PartyTypeDefinition(PartyTypes.CUSTOMER.name(), null),
049                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
050                        new SecurityRoleDefinition(SecurityRoleGroups.PartyPaymentMethod.name(), SecurityRoles.Choices.name())
051                        ))
052                ));
053
054        FORM_FIELD_DEFINITIONS = List.of(
055                new FieldDefinition("PartyName", 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 GetPartyPaymentMethodChoicesCommand */
062    public GetPartyPaymentMethodChoicesCommand() {
063        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
064    }
065    
066    @Override
067    protected BaseResult execute() {
068        var result = PaymentResultFactory.getGetPartyPaymentMethodChoicesResult();
069        var party = getParty();
070        var partyTypeName = getParty().getLastDetail().getPartyType().getPartyTypeName();
071
072        // If the caller is a CUSTOMER, then they're the Party. If they're not, the PartyName parameter is
073        // required, and we'll look them up.
074        if(!partyTypeName.equals(PartyTypes.CUSTOMER.name())) {
075            var partyName = form.getPartyName();
076
077            if(partyName == null) {
078                addExecutionError(ExecutionErrors.PartyNameRequired.name());
079            } else {
080                var partyControl = Session.getModelController(PartyControl.class);
081
082                party = partyControl.getPartyByName(partyName);
083
084                if(party == null) {
085                    addExecutionError(ExecutionErrors.UnknownPartyName.name(), partyName);
086                }
087            }
088        }
089
090        if(!hasExecutionErrors()) {
091            var partyPaymentMethodControl = Session.getModelController(PartyPaymentMethodControl.class);
092            var defaultPaymentMethodChoice = form.getDefaultPaymentMethodChoice();
093            var allowNullChoice = Boolean.parseBoolean(form.getAllowNullChoice());
094
095            result.setPartyPaymentMethodChoices(partyPaymentMethodControl.getPartyPaymentMethodChoices(defaultPaymentMethodChoice, getPreferredLanguage(), allowNullChoice,
096                    party));
097        }
098
099        return result;
100    }
101    
102}