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.GetPaymentMethodsForm;
020import com.echothree.control.user.payment.common.result.PaymentResultFactory;
021import com.echothree.model.control.party.common.PartyTypes;
022import com.echothree.model.control.payment.server.control.PaymentMethodControl;
023import com.echothree.model.control.payment.server.logic.PaymentMethodTypeLogic;
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.validation.FieldDefinition;
029import com.echothree.util.common.validation.FieldType;
030import com.echothree.util.server.control.BaseSimpleCommand;
031import com.echothree.util.server.control.CommandSecurityDefinition;
032import com.echothree.util.server.control.PartyTypeDefinition;
033import com.echothree.util.server.control.SecurityRoleDefinition;
034import com.echothree.util.server.persistence.Session;
035import java.util.Arrays;
036import java.util.Collections;
037import java.util.List;
038
039public class GetPaymentMethodsCommand
040        extends BaseSimpleCommand<GetPaymentMethodsForm> {
041    
042    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
043    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
044
045    static {
046        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(Collections.unmodifiableList(Arrays.asList(
047                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
048                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), Collections.unmodifiableList(Arrays.asList(
049                        new SecurityRoleDefinition(SecurityRoleGroups.PaymentMethod.name(), SecurityRoles.List.name())
050                        )))
051                )));
052
053        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
054                new FieldDefinition("PaymentMethodTypeName", FieldType.ENTITY_NAME, false, null, null)
055                ));
056    }
057
058    /** Creates a new instance of GetPaymentMethodsCommand */
059    public GetPaymentMethodsCommand(UserVisitPK userVisitPK, GetPaymentMethodsForm form) {
060        super(userVisitPK, form, COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
061    }
062    
063    @Override
064    protected BaseResult execute() {
065        var paymentMethodControl = Session.getModelController(PaymentMethodControl.class);
066        var result = PaymentResultFactory.getGetPaymentMethodsResult();
067        var paymentMethodTypeName = form.getPaymentMethodTypeName();
068        var paymentMethodType = paymentMethodTypeName == null ? null : PaymentMethodTypeLogic.getInstance().getPaymentMethodTypeByName(this, paymentMethodTypeName);
069
070        if(!hasExecutionErrors()) {
071            if(paymentMethodType == null) {
072                result.setPaymentMethods(paymentMethodControl.getPaymentMethodTransfers(getUserVisit()));
073            } else {
074                result.setPaymentMethods(paymentMethodControl.getPaymentMethodTransfersByPaymentMethodType(getUserVisit(), paymentMethodType));
075            }
076        }
077
078        return result;
079    }
080    
081}