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.GetPaymentProcessorTransactionCodesForm;
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.PaymentProcessorTransactionCodeControl;
023import com.echothree.model.control.payment.server.control.PaymentProcessorTransactionControl;
024import com.echothree.model.control.payment.server.logic.PaymentProcessorTransactionLogic;
025import com.echothree.model.control.security.common.SecurityRoleGroups;
026import com.echothree.model.control.security.common.SecurityRoles;
027import com.echothree.model.data.payment.server.entity.PaymentProcessorTransaction;
028import com.echothree.model.data.payment.server.entity.PaymentProcessorTransactionCode;
029import com.echothree.model.data.payment.server.factory.PaymentProcessorTransactionCodeFactory;
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 GetPaymentProcessorTransactionCodesCommand
044        extends BasePaginatedMultipleEntitiesCommand<PaymentProcessorTransactionCode, GetPaymentProcessorTransactionCodesForm> {
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.PaymentProcessorTransaction.name(), SecurityRoles.List.name())
054                ))
055        ));
056
057        FORM_FIELD_DEFINITIONS = List.of(
058                new FieldDefinition("PaymentProcessorTransactionName", FieldType.ENTITY_NAME, true, null, null)
059        );
060    }
061    
062    /** Creates a new instance of GetPaymentProcessorTransactionCodesCommand */
063    public GetPaymentProcessorTransactionCodesCommand() {
064        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, true);
065    }
066
067    @Inject
068    PaymentProcessorTransactionCodeControl paymentProcessorTransactionCodeControl;
069
070    @Inject
071    PaymentProcessorTransactionControl paymentProcessorTransactionControl;
072
073    @Inject
074    PaymentProcessorTransactionLogic paymentProcessorTransactionLogic;
075
076    private PaymentProcessorTransaction paymentProcessorTransaction;
077
078    @Override
079    protected void handleForm() {
080        paymentProcessorTransaction = paymentProcessorTransactionLogic.getPaymentProcessorTransactionByName(this, form.getPaymentProcessorTransactionName());
081    }
082
083    @Override
084    protected Long getTotalEntities() {
085        return hasExecutionErrors() ? null : paymentProcessorTransactionCodeControl.countPaymentProcessorTransactionCodesByPaymentProcessorTransaction(paymentProcessorTransaction);
086    }
087
088    @Override
089    protected Collection<PaymentProcessorTransactionCode> getEntities() {
090        return hasExecutionErrors() ? null : paymentProcessorTransactionCodeControl.getPaymentProcessorTransactionCodesByPaymentProcessorTransaction(paymentProcessorTransaction);
091    }
092
093    @Override
094    protected BaseResult getResult(Collection<PaymentProcessorTransactionCode> entities) {
095        var result = PaymentResultFactory.getGetPaymentProcessorTransactionCodesResult();
096
097        if(entities != null) {
098            var userVisit = getUserVisit();
099
100            result.setPaymentProcessorTransaction(paymentProcessorTransactionControl.getPaymentProcessorTransactionTransfer(userVisit, paymentProcessorTransaction));
101
102            if(session.hasLimit(PaymentProcessorTransactionCodeFactory.class)) {
103                result.setPaymentProcessorTransactionCodeCount(getTotalEntities());
104            }
105
106            result.setPaymentProcessorTransactionCodes(paymentProcessorTransactionCodeControl.getPaymentProcessorTransactionCodeTransfers(userVisit, entities));
107        }
108
109        return result;
110    }
111    
112}