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.accounting.server.command;
018
019import com.echothree.control.user.accounting.common.form.GetTransactionGlAccountCategoryForm;
020import com.echothree.control.user.accounting.common.result.AccountingResultFactory;
021import com.echothree.control.user.accounting.common.result.GetTransactionGlAccountCategoryResult;
022import com.echothree.model.control.accounting.server.control.AccountingControl;
023import com.echothree.model.control.core.common.EventTypes;
024import com.echothree.model.data.accounting.server.entity.TransactionGlAccountCategory;
025import com.echothree.model.data.accounting.server.entity.TransactionType;
026import com.echothree.model.data.user.common.pk.UserVisitPK;
027import com.echothree.util.common.message.ExecutionErrors;
028import com.echothree.util.common.validation.FieldDefinition;
029import com.echothree.util.common.validation.FieldType;
030import com.echothree.util.common.command.BaseResult;
031import com.echothree.util.server.control.BaseSimpleCommand;
032import com.echothree.util.server.persistence.Session;
033import java.util.Arrays;
034import java.util.Collections;
035import java.util.List;
036
037public class GetTransactionGlAccountCategoryCommand
038        extends BaseSimpleCommand<GetTransactionGlAccountCategoryForm> {
039    
040    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
041    
042    static {
043        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
044                new FieldDefinition("TransactionTypeName", FieldType.ENTITY_NAME, true, null, null),
045                new FieldDefinition("TransactionGlAccountCategoryName", FieldType.ENTITY_NAME, true, null, null)
046                ));
047    }
048    
049    /** Creates a new instance of GetTransactionGlAccountCategoryCommand */
050    public GetTransactionGlAccountCategoryCommand(UserVisitPK userVisitPK, GetTransactionGlAccountCategoryForm form) {
051        super(userVisitPK, form, null, FORM_FIELD_DEFINITIONS, false);
052    }
053    
054    @Override
055    protected BaseResult execute() {
056        var accountingControl = Session.getModelController(AccountingControl.class);
057        GetTransactionGlAccountCategoryResult result = AccountingResultFactory.getGetTransactionGlAccountCategoryResult();
058        String transactionTypeName = form.getTransactionTypeName();
059        TransactionType transactionType = accountingControl.getTransactionTypeByName(transactionTypeName);
060        
061        if(transactionType != null) {
062            String transactionGlAccountCategoryName = form.getTransactionGlAccountCategoryName();
063            TransactionGlAccountCategory transactionGlAccountCategory = accountingControl.getTransactionGlAccountCategoryByName(transactionType, transactionGlAccountCategoryName);
064            
065            if(transactionGlAccountCategory != null) {
066                result.setTransactionGlAccountCategory(accountingControl.getTransactionGlAccountCategoryTransfer(getUserVisit(), transactionGlAccountCategory));
067                
068                sendEvent(transactionGlAccountCategory.getPrimaryKey(), EventTypes.READ, null, null, getPartyPK());
069            } else {
070                addExecutionError(ExecutionErrors.UnknownTransactionGlAccountCategoryName.name(), transactionGlAccountCategoryName);
071            }
072        } else {
073            addExecutionError(ExecutionErrors.UnknownTransactionTypeName.name(), transactionTypeName);
074        }
075        
076        return result;
077    }
078    
079}