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.model.control.accounting.server.logic;
018
019import com.echothree.control.user.accounting.common.spec.TransactionGlAccountCategoryDescriptionSpec;
020import com.echothree.control.user.accounting.common.spec.TransactionGlAccountCategoryUniversalSpec;
021import com.echothree.model.control.accounting.common.exception.DuplicateTransactionGlAccountCategoryNameException;
022import com.echothree.model.control.accounting.common.exception.UnknownTransactionGlAccountCategoryDescriptionException;
023import com.echothree.model.control.accounting.common.exception.UnknownTransactionGlAccountCategoryNameException;
024import com.echothree.model.control.accounting.server.control.AccountingControl;
025import com.echothree.model.control.core.common.ComponentVendors;
026import com.echothree.model.control.core.common.EntityTypes;
027import com.echothree.model.control.core.common.exception.InvalidParameterCountException;
028import com.echothree.model.control.core.server.logic.EntityInstanceLogic;
029import com.echothree.model.control.party.server.logic.LanguageLogic;
030import com.echothree.model.data.accounting.server.entity.GlAccountCategory;
031import com.echothree.model.data.accounting.server.entity.TransactionGlAccountCategory;
032import com.echothree.model.data.accounting.server.entity.TransactionGlAccountCategoryDescription;
033import com.echothree.model.data.accounting.server.entity.TransactionType;
034import com.echothree.model.data.party.server.entity.Language;
035import com.echothree.util.common.message.ExecutionErrors;
036import com.echothree.util.common.persistence.BasePK;
037import com.echothree.util.server.control.BaseLogic;
038import com.echothree.util.server.message.ExecutionErrorAccumulator;
039import com.echothree.util.server.persistence.EntityPermission;
040import com.echothree.util.server.validation.ParameterUtils;
041import javax.enterprise.context.ApplicationScoped;
042import javax.inject.Inject;
043
044@ApplicationScoped
045public class TransactionGlAccountCategoryLogic
046        extends BaseLogic {
047
048    @Inject
049    AccountingControl accountingControl;
050
051    @Inject
052    EntityInstanceLogic entityInstanceLogic;
053
054    @Inject
055    LanguageLogic languageLogic;
056
057    @Inject
058    TransactionTypeLogic transactionTypeLogic;
059
060    protected TransactionGlAccountCategoryLogic() {
061        super();
062    }
063
064    public TransactionGlAccountCategory createTransactionGlAccountCategory(final ExecutionErrorAccumulator eea, final String transactionTypeName,
065            final String transactionGlAccountCategoryName, final GlAccountCategory glAccountCategory, final Integer sortOrder,
066            final Language language, final String description, final BasePK createdBy) {
067        var transactionType = transactionTypeLogic.getTransactionTypeByName(eea, transactionTypeName);
068        TransactionGlAccountCategory transactionGlAccountCategory = null;
069
070        if(eea == null || !eea.hasExecutionErrors()) {
071            transactionGlAccountCategory = createTransactionGlAccountCategory(eea, transactionType, transactionGlAccountCategoryName,
072                    glAccountCategory, sortOrder, language, description, createdBy);
073        }
074
075        return transactionGlAccountCategory;
076    }
077
078    public TransactionGlAccountCategory createTransactionGlAccountCategory(final ExecutionErrorAccumulator eea, final TransactionType transactionType,
079            final String transactionGlAccountCategoryName, final GlAccountCategory glAccountCategory, final Integer sortOrder, final Language language,
080            final String description, final BasePK createdBy) {
081        var transactionGlAccountCategory = accountingControl.getTransactionGlAccountCategoryByName(transactionType, transactionGlAccountCategoryName);
082
083        if(transactionGlAccountCategory == null) {
084            transactionGlAccountCategory = accountingControl.createTransactionGlAccountCategory(transactionType, transactionGlAccountCategoryName,
085                    glAccountCategory, sortOrder, createdBy);
086
087            if(description != null) {
088                accountingControl.createTransactionGlAccountCategoryDescription(transactionGlAccountCategory, language, description, createdBy);
089            }
090        } else {
091            handleExecutionError(DuplicateTransactionGlAccountCategoryNameException.class, eea, ExecutionErrors.DuplicateTransactionGlAccountCategoryName.name(), transactionGlAccountCategoryName);
092        }
093        return transactionGlAccountCategory;
094    }
095
096    public TransactionGlAccountCategory getTransactionGlAccountCategoryByName(final ExecutionErrorAccumulator eea,
097            final TransactionType transactionType, final String transactionGlAccountCategoryName,
098            final EntityPermission entityPermission) {
099        var transactionGlAccountCategory = accountingControl.getTransactionGlAccountCategoryByName(transactionType, transactionGlAccountCategoryName, entityPermission);
100
101        if(transactionGlAccountCategory == null) {
102            handleExecutionError(UnknownTransactionGlAccountCategoryNameException.class, eea, ExecutionErrors.UnknownTransactionGlAccountCategoryName.name(),
103                    transactionType.getLastDetail().getTransactionTypeName(), transactionGlAccountCategoryName);
104        }
105
106        return transactionGlAccountCategory;
107    }
108
109    public TransactionGlAccountCategory getTransactionGlAccountCategoryByName(final ExecutionErrorAccumulator eea,
110            final TransactionType transactionType, final String transactionGlAccountCategoryName) {
111        return getTransactionGlAccountCategoryByName(eea, transactionType, transactionGlAccountCategoryName, EntityPermission.READ_ONLY);
112    }
113
114    public TransactionGlAccountCategory getTransactionGlAccountCategoryByNameForUpdate(final ExecutionErrorAccumulator eea,
115            final TransactionType transactionType, final String transactionGlAccountCategoryName) {
116        return getTransactionGlAccountCategoryByName(eea, transactionType, transactionGlAccountCategoryName, EntityPermission.READ_WRITE);
117    }
118
119    public TransactionGlAccountCategory getTransactionGlAccountCategoryByName(final ExecutionErrorAccumulator eea,
120            final String transactionTypeName, final String transactionGlAccountCategoryName,
121            final EntityPermission entityPermission) {
122        var transactionType = transactionTypeLogic.getTransactionTypeByName(eea, transactionTypeName);
123        TransactionGlAccountCategory transactionGlAccountCategory = null;
124
125        if(eea == null || !eea.hasExecutionErrors()) {
126            transactionGlAccountCategory = getTransactionGlAccountCategoryByName(eea, transactionType, transactionGlAccountCategoryName, entityPermission);
127        }
128
129        return transactionGlAccountCategory;
130    }
131
132    public TransactionGlAccountCategory getTransactionGlAccountCategoryByName(final ExecutionErrorAccumulator eea,
133            final String transactionTypeName, final String transactionGlAccountCategoryName) {
134        return getTransactionGlAccountCategoryByName(eea, transactionTypeName, transactionGlAccountCategoryName, EntityPermission.READ_ONLY);
135    }
136
137    public TransactionGlAccountCategory getTransactionGlAccountCategoryByNameForUpdate(final ExecutionErrorAccumulator eea,
138            final String transactionTypeName, final String transactionGlAccountCategoryName) {
139        return getTransactionGlAccountCategoryByName(eea, transactionTypeName, transactionGlAccountCategoryName, EntityPermission.READ_WRITE);
140    }
141
142    public TransactionGlAccountCategory getTransactionGlAccountCategoryByUniversalSpec(final ExecutionErrorAccumulator eea,
143            final TransactionGlAccountCategoryUniversalSpec universalSpec, final EntityPermission entityPermission) {
144        var transactionTypeName = universalSpec.getTransactionTypeName();
145        var transactionGlAccountCategoryName = universalSpec.getTransactionGlAccountCategoryName();
146        var nameParameterCount= ParameterUtils.getInstance().countNonNullParameters(transactionTypeName, transactionGlAccountCategoryName);
147        var possibleEntitySpecs= entityInstanceLogic.countPossibleEntitySpecs(universalSpec);
148        TransactionGlAccountCategory transactionGlAccountCategory = null;
149
150        if(nameParameterCount == 2 && possibleEntitySpecs == 0) {
151            var transactionType = transactionTypeLogic.getTransactionTypeByName(eea, transactionTypeName);
152
153            if(eea == null || !eea.hasExecutionErrors()) {
154                transactionGlAccountCategory = getTransactionGlAccountCategoryByName(eea, transactionType, transactionGlAccountCategoryName, entityPermission);
155            }
156        } else if(nameParameterCount == 0 && possibleEntitySpecs == 1) {
157            var entityInstance = entityInstanceLogic.getEntityInstance(eea, universalSpec,
158                    ComponentVendors.ECHO_THREE.name(), EntityTypes.TransactionGlAccountCategory.name());
159
160            if(eea == null || !eea.hasExecutionErrors()) {
161                transactionGlAccountCategory = accountingControl.getTransactionGlAccountCategoryByEntityInstance(entityInstance, entityPermission);
162            }
163        } else {
164            handleExecutionError(InvalidParameterCountException.class, eea, ExecutionErrors.InvalidParameterCount.name());
165        }
166
167        return transactionGlAccountCategory;
168    }
169
170    public TransactionGlAccountCategory getTransactionGlAccountCategoryByUniversalSpec(final ExecutionErrorAccumulator eea,
171            final TransactionGlAccountCategoryUniversalSpec universalSpec) {
172        return getTransactionGlAccountCategoryByUniversalSpec(eea, universalSpec, EntityPermission.READ_ONLY);
173    }
174
175    public TransactionGlAccountCategory getTransactionGlAccountCategoryByUniversalSpecForUpdate(final ExecutionErrorAccumulator eea,
176            final TransactionGlAccountCategoryUniversalSpec universalSpec) {
177        return getTransactionGlAccountCategoryByUniversalSpec(eea, universalSpec, EntityPermission.READ_WRITE);
178    }
179
180    public TransactionGlAccountCategoryDescription getTransactionGlAccountCategoryDescriptionBySpec(final ExecutionErrorAccumulator eea,
181            final TransactionGlAccountCategoryDescriptionSpec spec, final EntityPermission entityPermission) {
182        TransactionGlAccountCategoryDescription transactionGlAccountCategoryDescription = null;
183        var transactionTypeName = spec.getTransactionTypeName();
184        var transactionGlAccountCategoryName = spec.getTransactionGlAccountCategoryName();
185        var transactionGlAccountCategory = getTransactionGlAccountCategoryByName(eea,
186                transactionTypeName, transactionGlAccountCategoryName);
187
188        if(!hasExecutionErrors(eea)) {
189            var languageIsoName = spec.getLanguageIsoName();
190            var language = languageLogic.getLanguageByName(eea, languageIsoName);
191
192            if(!hasExecutionErrors(eea)) {
193                transactionGlAccountCategoryDescription = accountingControl.getTransactionGlAccountCategoryDescription(transactionGlAccountCategory,
194                        language, entityPermission);
195
196                if(transactionGlAccountCategoryDescription == null) {
197                    handleExecutionError(UnknownTransactionGlAccountCategoryDescriptionException.class, eea, ExecutionErrors.UnknownTransactionGlAccountCategoryDescription.name(), transactionTypeName,
198                            transactionGlAccountCategoryName, languageIsoName);
199                }
200            }
201        }
202
203        return transactionGlAccountCategoryDescription;
204    }
205
206    public void deleteTransactionGlAccountCategory(final ExecutionErrorAccumulator eea, final TransactionGlAccountCategory transactionGlAccountCategory,
207            final BasePK deletedBy) {
208        accountingControl.deleteTransactionGlAccountCategory(transactionGlAccountCategory, deletedBy);
209    }
210
211}