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.GetPaymentProcessorTransactionsForm;
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.PaymentProcessorTransactionControl;
023import com.echothree.model.control.security.common.SecurityRoleGroups;
024import com.echothree.model.control.security.common.SecurityRoles;
025import com.echothree.model.data.payment.server.entity.PaymentProcessorTransaction;
026import com.echothree.model.data.payment.server.factory.PaymentProcessorTransactionFactory;
027import com.echothree.util.common.command.BaseResult;
028import com.echothree.util.common.validation.FieldDefinition;
029import com.echothree.util.server.control.BasePaginatedMultipleEntitiesCommand;
030import com.echothree.util.server.control.CommandSecurityDefinition;
031import com.echothree.util.server.control.PartyTypeDefinition;
032import com.echothree.util.server.control.SecurityRoleDefinition;
033import java.util.Collection;
034import java.util.List;
035import javax.enterprise.context.Dependent;
036import javax.inject.Inject;
037
038@Dependent
039public class GetPaymentProcessorTransactionsCommand
040        extends BasePaginatedMultipleEntitiesCommand<PaymentProcessorTransaction, GetPaymentProcessorTransactionsForm> {
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(List.of(
047                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
048                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
049                        new SecurityRoleDefinition(SecurityRoleGroups.PaymentProcessorTransaction.name(), SecurityRoles.List.name())
050                ))
051        ));
052
053        FORM_FIELD_DEFINITIONS = List.of();
054    }
055    
056    /** Creates a new instance of GetPaymentProcessorTransactionsCommand */
057    public GetPaymentProcessorTransactionsCommand() {
058        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, true);
059    }
060
061    @Inject
062    PaymentProcessorTransactionControl paymentProcessorTransactionControl;
063
064    @Override
065    protected void handleForm() {
066        // No form fields.
067    }
068
069    @Override
070    protected Long getTotalEntities() {
071        return paymentProcessorTransactionControl.countPaymentProcessorTransactions();
072    }
073
074    @Override
075    protected Collection<PaymentProcessorTransaction> getEntities() {
076        return paymentProcessorTransactionControl.getPaymentProcessorTransactions();
077    }
078
079    @Override
080    protected BaseResult getResult(Collection<PaymentProcessorTransaction> entities) {
081        var result = PaymentResultFactory.getGetPaymentProcessorTransactionsResult();
082
083        if(entities != null) {
084            var userVisit = getUserVisit();
085
086            if(session.hasLimit(PaymentProcessorTransactionFactory.class)) {
087                result.setPaymentProcessorTransactionCount(paymentProcessorTransactionControl.countPaymentProcessorTransactions());
088            }
089
090            result.setPaymentProcessorTransactions(paymentProcessorTransactionControl.getPaymentProcessorTransactionTransfers(userVisit, entities));
091        }
092
093        return result;
094    }
095    
096}