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.accounting.server.command;
018
019import com.echothree.control.user.accounting.common.edit.AccountingEditFactory;
020import com.echothree.control.user.accounting.common.edit.TransactionGlAccountCategoryDescriptionEdit;
021import com.echothree.control.user.accounting.common.result.AccountingResultFactory;
022import com.echothree.control.user.accounting.common.result.EditTransactionGlAccountCategoryDescriptionResult;
023import com.echothree.control.user.accounting.common.spec.TransactionGlAccountCategoryDescriptionSpec;
024import com.echothree.model.control.accounting.server.control.AccountingControl;
025import com.echothree.model.control.accounting.server.logic.TransactionGlAccountCategoryLogic;
026import com.echothree.model.control.party.common.PartyTypes;
027import com.echothree.model.control.security.common.SecurityRoleGroups;
028import com.echothree.model.control.security.common.SecurityRoles;
029import com.echothree.model.data.accounting.server.entity.TransactionGlAccountCategory;
030import com.echothree.model.data.accounting.server.entity.TransactionGlAccountCategoryDescription;
031import com.echothree.util.common.validation.FieldDefinition;
032import com.echothree.util.common.validation.FieldType;
033import com.echothree.util.server.control.BaseAbstractEditCommand;
034import com.echothree.util.server.control.CommandSecurityDefinition;
035import com.echothree.util.server.control.PartyTypeDefinition;
036import com.echothree.util.server.control.SecurityRoleDefinition;
037import java.util.List;
038import javax.enterprise.context.Dependent;
039import javax.inject.Inject;
040
041@Dependent
042public class EditTransactionGlAccountCategoryDescriptionCommand
043        extends BaseAbstractEditCommand<TransactionGlAccountCategoryDescriptionSpec, TransactionGlAccountCategoryDescriptionEdit, EditTransactionGlAccountCategoryDescriptionResult, TransactionGlAccountCategoryDescription, TransactionGlAccountCategory> {
044
045    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
046    private final static List<FieldDefinition> SPEC_FIELD_DEFINITIONS;
047    private final static List<FieldDefinition> EDIT_FIELD_DEFINITIONS;
048
049    static {
050        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(List.of(
051                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
052                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
053                        new SecurityRoleDefinition(SecurityRoleGroups.TransactionGlAccountCategory.name(), SecurityRoles.Description.name())
054                ))
055        ));
056
057        SPEC_FIELD_DEFINITIONS = List.of(
058                new FieldDefinition("TransactionTypeName", FieldType.ENTITY_NAME, true, null, null),
059                new FieldDefinition("TransactionGlAccountCategoryName", FieldType.ENTITY_NAME, true, null, null),
060                new FieldDefinition("LanguageIsoName", FieldType.ENTITY_NAME, true, null, null)
061        );
062
063        EDIT_FIELD_DEFINITIONS = List.of(
064                new FieldDefinition("Description", FieldType.STRING, true, 1L, 132L)
065        );
066    }
067
068    @Inject
069    AccountingControl accountingControl;
070
071    @Inject
072    TransactionGlAccountCategoryLogic transactionGlAccountCategoryLogic;
073
074    /** Creates a new instance of EditTransactionGlAccountCategoryDescriptionCommand */
075    public EditTransactionGlAccountCategoryDescriptionCommand() {
076        super(COMMAND_SECURITY_DEFINITION, SPEC_FIELD_DEFINITIONS, EDIT_FIELD_DEFINITIONS);
077    }
078
079    @Override
080    public EditTransactionGlAccountCategoryDescriptionResult getResult() {
081        return AccountingResultFactory.getEditTransactionGlAccountCategoryDescriptionResult();
082    }
083
084    @Override
085    public TransactionGlAccountCategoryDescriptionEdit getEdit() {
086        return AccountingEditFactory.getTransactionGlAccountCategoryDescriptionEdit();
087    }
088
089    @Override
090    public TransactionGlAccountCategoryDescription getEntity(EditTransactionGlAccountCategoryDescriptionResult result) {
091        return transactionGlAccountCategoryLogic.getTransactionGlAccountCategoryDescriptionBySpec(this, spec, editModeToEntityPermission(editMode));
092    }
093
094    @Override
095    public TransactionGlAccountCategory getLockEntity(TransactionGlAccountCategoryDescription transactionGlAccountCategoryDescription) {
096        return transactionGlAccountCategoryDescription.getTransactionGlAccountCategory();
097    }
098
099    @Override
100    public void fillInResult(EditTransactionGlAccountCategoryDescriptionResult result, TransactionGlAccountCategoryDescription transactionGlAccountCategoryDescription) {
101        result.setTransactionGlAccountCategoryDescription(accountingControl.getTransactionGlAccountCategoryDescriptionTransfer(getUserVisit(), transactionGlAccountCategoryDescription));
102    }
103
104    @Override
105    public void doLock(TransactionGlAccountCategoryDescriptionEdit edit, TransactionGlAccountCategoryDescription transactionGlAccountCategoryDescription) {
106        edit.setDescription(transactionGlAccountCategoryDescription.getDescription());
107    }
108
109    @Override
110    public void doUpdate(TransactionGlAccountCategoryDescription transactionGlAccountCategoryDescription) {
111        var transactionGlAccountCategoryDescriptionValue = accountingControl.getTransactionGlAccountCategoryDescriptionValue(transactionGlAccountCategoryDescription);
112
113        transactionGlAccountCategoryDescriptionValue.setDescription(edit.getDescription());
114
115        accountingControl.updateTransactionGlAccountCategoryDescriptionFromValue(transactionGlAccountCategoryDescriptionValue, getPartyPK());
116    }
117
118}