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.GetPaymentProcessorTransactionsForm;
020import com.echothree.control.user.payment.common.result.GetPaymentProcessorTransactionsResult;
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.PaymentProcessorTransactionControl;
024import com.echothree.model.control.security.common.SecurityRoleGroups;
025import com.echothree.model.control.security.common.SecurityRoles;
026import com.echothree.model.data.payment.server.entity.PaymentProcessorTransaction;
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.server.control.BaseMultipleEntitiesCommand;
031import com.echothree.util.server.control.CommandSecurityDefinition;
032import com.echothree.util.server.control.PartyTypeDefinition;
033import com.echothree.util.server.control.SecurityRoleDefinition;
034import com.echothree.util.server.persistence.Session;
035import java.util.Arrays;
036import java.util.Collection;
037import java.util.Collections;
038import java.util.List;
039
040public class GetPaymentProcessorTransactionsCommand
041        extends BaseMultipleEntitiesCommand<PaymentProcessorTransaction, GetPaymentProcessorTransactionsForm> {
042
043    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
044    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
045
046    static {
047        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(Collections.unmodifiableList(Arrays.asList(
048                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
049                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), Collections.unmodifiableList(Arrays.asList(
050                        new SecurityRoleDefinition(SecurityRoleGroups.PaymentProcessorTransaction.name(), SecurityRoles.List.name())
051                )))
052        )));
053
054        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
055        ));
056    }
057    
058    /** Creates a new instance of GetPaymentProcessorTransactionsCommand */
059    public GetPaymentProcessorTransactionsCommand(UserVisitPK userVisitPK, GetPaymentProcessorTransactionsForm form) {
060        super(userVisitPK, form, COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, true);
061    }
062    
063    @Override
064    protected Collection<PaymentProcessorTransaction> getEntities() {
065        var paymentProcessorTransactionControl = Session.getModelController(PaymentProcessorTransactionControl.class);
066        
067        return paymentProcessorTransactionControl.getPaymentProcessorTransactions();
068    }
069    
070    @Override
071    protected BaseResult getResult(Collection<PaymentProcessorTransaction> entities) {
072        GetPaymentProcessorTransactionsResult result = PaymentResultFactory.getGetPaymentProcessorTransactionsResult();
073        var paymentProcessorTransactionControl = Session.getModelController(PaymentProcessorTransactionControl.class);
074        
075        result.setPaymentProcessorTransactions(paymentProcessorTransactionControl.getPaymentProcessorTransactionTransfers(getUserVisit(), entities));
076        
077        return result;
078    }
079    
080}