001// --------------------------------------------------------------------------------
002// Copyright 2002-2024 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.GetPartyPaymentMethodChoicesResult;
021import com.echothree.control.user.payment.common.result.PaymentResultFactory;
022import com.echothree.model.control.party.common.PartyTypes;
023import com.echothree.model.control.party.server.control.PartyControl;
024import com.echothree.model.control.payment.server.control.PartyPaymentMethodControl;
025import com.echothree.model.control.security.common.SecurityRoleGroups;
026import com.echothree.model.control.security.common.SecurityRoles;
027import com.echothree.model.data.party.server.entity.Party;
028import com.echothree.model.data.user.common.pk.UserVisitPK;
029import com.echothree.util.common.command.BaseResult;
030import com.echothree.util.common.message.ExecutionErrors;
031import com.echothree.util.common.validation.FieldDefinition;
032import com.echothree.util.common.validation.FieldType;
033import com.echothree.util.server.control.BaseSimpleCommand;
034import com.echothree.util.server.control.CommandSecurityDefinition;
035import com.echothree.util.server.control.PartyTypeDefinition;
036import com.echothree.util.server.control.SecurityRoleDefinition;
037import com.echothree.util.server.persistence.Session;
038import java.util.Arrays;
039import java.util.Collections;
040import java.util.List;
041
042public class GetPartyPaymentMethodChoicesCommand
043        extends BaseSimpleCommand<GetPartyPaymentMethodChoicesForm> {
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.CUSTOMER.name(), null),
051                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), Collections.unmodifiableList(Arrays.asList(
052                        new SecurityRoleDefinition(SecurityRoleGroups.PartyPaymentMethod.name(), SecurityRoles.Choices.name())
053                        )))
054                )));
055
056        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
057                new FieldDefinition("PartyName", FieldType.ENTITY_NAME, false, null, null),
058                new FieldDefinition("DefaultPaymentMethodChoice", FieldType.ENTITY_NAME, false, null, null),
059                new FieldDefinition("AllowNullChoice", FieldType.BOOLEAN, true, null, null)
060                ));
061    }
062    
063    /** Creates a new instance of GetPartyPaymentMethodChoicesCommand */
064    public GetPartyPaymentMethodChoicesCommand(UserVisitPK userVisitPK, GetPartyPaymentMethodChoicesForm form) {
065        super(userVisitPK, form, COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
066    }
067    
068    @Override
069    protected BaseResult execute() {
070        GetPartyPaymentMethodChoicesResult result = PaymentResultFactory.getGetPartyPaymentMethodChoicesResult();
071        Party party = getParty();
072        String partyTypeName = getParty().getLastDetail().getPartyType().getPartyTypeName();
073
074        // If the caller is a CUSTOMER, then they're the Party. If they're not, the PartyName parameter is
075        // required, and we'll look them up.
076        if(!partyTypeName.equals(PartyTypes.CUSTOMER.name())) {
077            String partyName = form.getPartyName();
078
079            if(partyName == null) {
080                addExecutionError(ExecutionErrors.PartyNameRequired.name());
081            } else {
082                var partyControl = Session.getModelController(PartyControl.class);
083
084                party = partyControl.getPartyByName(partyName);
085
086                if(party == null) {
087                    addExecutionError(ExecutionErrors.UnknownPartyName.name(), partyName);
088                }
089            }
090        }
091
092        if(!hasExecutionErrors()) {
093            var partyPaymentMethodControl = Session.getModelController(PartyPaymentMethodControl.class);
094            String defaultPaymentMethodChoice = form.getDefaultPaymentMethodChoice();
095            boolean allowNullChoice = Boolean.parseBoolean(form.getAllowNullChoice());
096
097            result.setPartyPaymentMethodChoices(partyPaymentMethodControl.getPartyPaymentMethodChoices(defaultPaymentMethodChoice, getPreferredLanguage(), allowNullChoice,
098                    party));
099        }
100
101        return result;
102    }
103    
104}