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.logic.PaymentProcessorTransactionLogic;
024import com.echothree.model.control.security.common.SecurityRoleGroups;
025import com.echothree.model.control.security.common.SecurityRoles;
026import com.echothree.model.data.payment.server.entity.PaymentProcessorTransactionCode;
027import com.echothree.model.data.user.common.pk.UserVisitPK;
028import com.echothree.util.common.command.BaseResult;
029import com.echothree.util.common.validation.FieldDefinition;
030import com.echothree.util.common.validation.FieldType;
031import com.echothree.util.server.control.BaseMultipleEntitiesCommand;
032import com.echothree.util.server.control.CommandSecurityDefinition;
033import com.echothree.util.server.control.PartyTypeDefinition;
034import com.echothree.util.server.control.SecurityRoleDefinition;
035import com.echothree.util.server.persistence.Session;
036import java.util.Collection;
037import java.util.List;
038import javax.enterprise.context.Dependent;
039
040@Dependent
041public class GetPaymentProcessorTransactionCodesCommand
042        extends BaseMultipleEntitiesCommand<PaymentProcessorTransactionCode, GetPaymentProcessorTransactionCodesForm> {
043
044    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
045    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
046
047    static {
048        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(List.of(
049                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
050                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
051                        new SecurityRoleDefinition(SecurityRoleGroups.PaymentProcessorTransaction.name(), SecurityRoles.List.name())
052                ))
053        ));
054
055        FORM_FIELD_DEFINITIONS = List.of(
056                new FieldDefinition("PaymentProcessorTransactionName", FieldType.ENTITY_NAME, true, null, null)
057        );
058    }
059    
060    /** Creates a new instance of GetPaymentProcessorTransactionCodesCommand */
061    public GetPaymentProcessorTransactionCodesCommand() {
062        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, true);
063    }
064    
065    @Override
066    protected Collection<PaymentProcessorTransactionCode> getEntities() {
067        Collection<PaymentProcessorTransactionCode> paymentProcessorTransactionCodes = null;
068        var paymentProcessorTransaction = PaymentProcessorTransactionLogic.getInstance().getPaymentProcessorTransactionByName(this, form.getPaymentProcessorTransactionName());
069
070        if(!hasExecutionErrors()) {
071            var paymentProcessorTransactionCodeControl = Session.getModelController(PaymentProcessorTransactionCodeControl.class);
072
073            paymentProcessorTransactionCodes = paymentProcessorTransactionCodeControl.getPaymentProcessorTransactionCodesByPaymentProcessorTransaction(paymentProcessorTransaction);
074        }
075        return paymentProcessorTransactionCodes;
076    }
077    
078    @Override
079    protected BaseResult getResult(Collection<PaymentProcessorTransactionCode> entities) {
080        var result = PaymentResultFactory.getGetPaymentProcessorTransactionCodesResult();
081        var paymentProcessorTransactionCodeControl = Session.getModelController(PaymentProcessorTransactionCodeControl.class);
082        
083        result.setPaymentProcessorTransactionCodes(paymentProcessorTransactionCodeControl.getPaymentProcessorTransactionCodeTransfers(getUserVisit(), entities));
084        
085        return result;
086    }
087    
088}