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