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