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.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.control.PaymentMethodTypeControl;
024import com.echothree.model.control.payment.server.logic.PaymentMethodTypeLogic;
025import com.echothree.model.control.security.common.SecurityRoleGroups;
026import com.echothree.model.control.security.common.SecurityRoles;
027import com.echothree.model.data.payment.server.entity.PaymentMethod;
028import com.echothree.model.data.payment.server.entity.PaymentMethodType;
029import com.echothree.model.data.payment.server.factory.PaymentMethodFactory;
030import com.echothree.util.common.command.BaseResult;
031import com.echothree.util.common.validation.FieldDefinition;
032import com.echothree.util.common.validation.FieldType;
033import com.echothree.util.server.control.BasePaginatedMultipleEntitiesCommand;
034import com.echothree.util.server.control.CommandSecurityDefinition;
035import com.echothree.util.server.control.PartyTypeDefinition;
036import com.echothree.util.server.control.SecurityRoleDefinition;
037import java.util.Collection;
038import java.util.List;
039import javax.enterprise.context.Dependent;
040import javax.inject.Inject;
041
042@Dependent
043public class GetPaymentMethodsCommand
044        extends BasePaginatedMultipleEntitiesCommand<PaymentMethod, GetPaymentMethodsForm> {
045    
046    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
047    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
048
049    static {
050        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(List.of(
051                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
052                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
053                        new SecurityRoleDefinition(SecurityRoleGroups.PaymentMethod.name(), SecurityRoles.List.name())
054                ))
055        ));
056
057        FORM_FIELD_DEFINITIONS = List.of(
058                new FieldDefinition("PaymentMethodTypeName", FieldType.ENTITY_NAME, false, null, null)
059        );
060    }
061
062    @Inject
063    PaymentMethodControl paymentMethodControl;
064
065    @Inject
066    PaymentMethodTypeControl paymentMethodTypeControl;
067
068    @Inject
069    PaymentMethodTypeLogic paymentMethodTypeLogic;
070
071    /** Creates a new instance of GetPaymentMethodsCommand */
072    public GetPaymentMethodsCommand() {
073        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, true);
074    }
075
076    private PaymentMethodType paymentMethodType;
077
078    @Override
079    protected void handleForm() {
080        var paymentMethodTypeName = form.getPaymentMethodTypeName();
081
082        paymentMethodType = paymentMethodTypeName == null ? null : paymentMethodTypeLogic.getPaymentMethodTypeByName(this, paymentMethodTypeName);
083    }
084
085    @Override
086    protected Long getTotalEntities() {
087        return hasExecutionErrors() ? null :
088                paymentMethodType == null ? paymentMethodControl.countPaymentMethods() :
089                        paymentMethodControl.countPaymentMethodsByPaymentMethodType(paymentMethodType);
090    }
091
092    @Override
093    protected Collection<PaymentMethod> getEntities() {
094        return hasExecutionErrors() ? null :
095                paymentMethodType == null ? paymentMethodControl.getPaymentMethods() :
096                        paymentMethodControl.getPaymentMethodsByPaymentMethodType(paymentMethodType);
097    }
098
099    @Override
100    protected BaseResult getResult(Collection<PaymentMethod> entities) {
101        var result = PaymentResultFactory.getGetPaymentMethodsResult();
102
103        if(entities != null) {
104            var userVisit = getUserVisit();
105
106            if(paymentMethodType != null) {
107                result.setPaymentMethodType(paymentMethodTypeControl.getPaymentMethodTypeTransfer(userVisit, paymentMethodType));
108            }
109
110            if(session.hasLimit(PaymentMethodFactory.class)) {
111                result.setPaymentMethodCount(getTotalEntities());
112            }
113
114            result.setPaymentMethods(paymentMethodControl.getPaymentMethodTransfers(userVisit, entities));
115        }
116
117        return result;
118    }
119    
120}