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.GetPartyPaymentMethodForm;
020import com.echothree.control.user.payment.common.result.PaymentResultFactory;
021import com.echothree.model.control.core.common.EventTypes;
022import com.echothree.model.control.party.common.PartyTypes;
023import com.echothree.model.control.payment.server.control.PartyPaymentMethodControl;
024import com.echothree.model.control.payment.server.logic.PartyPaymentMethodLogic;
025import com.echothree.model.control.security.common.SecurityRoleGroups;
026import com.echothree.model.control.security.common.SecurityRoles;
027import com.echothree.model.data.payment.server.entity.PartyPaymentMethod;
028import com.echothree.util.common.command.BaseResult;
029import com.echothree.util.common.message.ExecutionErrors;
030import com.echothree.util.common.validation.FieldDefinition;
031import com.echothree.util.common.validation.FieldType;
032import com.echothree.util.server.control.BaseSingleEntityCommand;
033import com.echothree.util.server.control.CommandSecurityDefinition;
034import com.echothree.util.server.control.PartyTypeDefinition;
035import com.echothree.util.server.control.SecurityRoleDefinition;
036import java.util.List;
037import javax.enterprise.context.Dependent;
038import javax.inject.Inject;
039
040@Dependent
041public class GetPartyPaymentMethodCommand
042        extends BaseSingleEntityCommand<PartyPaymentMethod, GetPartyPaymentMethodForm> {
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(List.of(
049                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
050                new PartyTypeDefinition(PartyTypes.CUSTOMER.name(), null),
051                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
052                        new SecurityRoleDefinition(SecurityRoleGroups.PartyPaymentMethod.name(), SecurityRoles.Review.name())
053                ))
054        ));
055
056        FORM_FIELD_DEFINITIONS = List.of(
057                new FieldDefinition("PartyPaymentMethodName", FieldType.ENTITY_NAME, true, null, null)
058        );
059    }
060
061    @Inject
062    PartyPaymentMethodControl partyPaymentMethodControl;
063
064    @Inject
065    PartyPaymentMethodLogic partyPaymentMethodLogic;
066
067    /** Creates a new instance of GetPartyPaymentMethodCommand */
068    public GetPartyPaymentMethodCommand() {
069        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, true);
070    }
071    
072    
073    @Override
074    protected PartyPaymentMethod getEntity() {
075        var partyPaymentMethodName = form.getPartyPaymentMethodName();
076        var partyPaymentMethod = partyPaymentMethodLogic.getPartyPaymentMethodByName(this, partyPaymentMethodName);
077        
078        if(!hasExecutionErrors()) {
079            var party = getParty();
080            var partyTypeName = party.getLastDetail().getPartyType().getPartyTypeName();
081
082            // If the executing Party is a CUSTOMER, and the PartyPaymentMethod isn't for the executing Party,
083            // return a UnknownPartyPaymentMethodName error.
084            if(partyTypeName.equals(PartyTypes.CUSTOMER.name())) {
085                if(!partyPaymentMethod.getLastDetail().getParty().equals(party)) {
086                    addExecutionError(ExecutionErrors.UnknownPartyPaymentMethodName.name(), partyPaymentMethodName);
087                    partyPaymentMethod = null;
088                }
089            }
090        }
091
092        if(!hasExecutionErrors()) {
093            sendEvent(partyPaymentMethod.getPrimaryKey(), EventTypes.READ, null, null, getPartyPK());
094        }
095        
096        return partyPaymentMethod;
097    }
098
099    @Override
100    protected BaseResult getResult(PartyPaymentMethod partyPaymentMethod) {
101        var result = PaymentResultFactory.getGetPartyPaymentMethodResult();
102
103        if(!hasExecutionErrors()) {
104            result.setPartyPaymentMethod(partyPaymentMethodControl.getPartyPaymentMethodTransfer(getUserVisit(), partyPaymentMethod));
105        }
106
107        return result;
108    }
109    
110}