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.GetPartyPaymentMethodsForm;
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 GetPartyPaymentMethodsCommand
041        extends BaseSimpleCommand<GetPartyPaymentMethodsForm> {
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.UTILITY.name(), null),
049                new PartyTypeDefinition(PartyTypes.CUSTOMER.name(), null),
050                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
051                        new SecurityRoleDefinition(SecurityRoleGroups.PartyPaymentMethod.name(), SecurityRoles.List.name())
052                        ))
053                ));
054
055        FORM_FIELD_DEFINITIONS = List.of(
056                new FieldDefinition("PartyName", FieldType.ENTITY_NAME, false, null, null),
057                new FieldDefinition("DefaultPaymentMethod", FieldType.ENTITY_NAME, false, null, null),
058                new FieldDefinition("AllowNull", FieldType.BOOLEAN, true, null, null)
059                );
060    }
061    
062    /** Creates a new instance of GetPartyPaymentMethodsCommand */
063    public GetPartyPaymentMethodsCommand() {
064        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
065    }
066    
067    @Override
068    protected BaseResult execute() {
069        var result = PaymentResultFactory.getGetPartyPaymentMethodsResult();
070        var party = getParty();
071        var partyTypeName = party.getLastDetail().getPartyType().getPartyTypeName();
072
073        // If the caller is a CUSTOMER, then they're the Party. If they're not, the PartyName parameter is
074        // required, and we'll look them up.
075        if(!partyTypeName.equals(PartyTypes.CUSTOMER.name())) {
076            var partyName = form.getPartyName();
077
078            if(partyName == null) {
079                addExecutionError(ExecutionErrors.PartyNameRequired.name());
080            } else {
081                var partyControl = Session.getModelController(PartyControl.class);
082
083                party = partyControl.getPartyByName(partyName);
084
085                if(party == null) {
086                    addExecutionError(ExecutionErrors.UnknownPartyName.name(), partyName);
087                }
088            }
089        }
090
091        if(!hasExecutionErrors()) {
092            var partyPaymentMethodControl = Session.getModelController(PartyPaymentMethodControl.class);
093
094            result.setPartyPaymentMethods(partyPaymentMethodControl.getPartyPaymentMethodTransfersByParty(getUserVisit(), party));
095        }
096
097        return result;
098    }
099    
100}