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.SymbolPositionEdit;
021import com.echothree.control.user.accounting.common.result.AccountingResultFactory;
022import com.echothree.control.user.accounting.common.result.EditSymbolPositionResult;
023import com.echothree.control.user.accounting.common.spec.SymbolPositionSpec;
024import com.echothree.model.control.accounting.server.control.AccountingControl;
025import com.echothree.model.control.accounting.server.logic.SymbolPositionLogic;
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.SymbolPosition;
030import com.echothree.util.common.message.ExecutionErrors;
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 EditSymbolPositionCommand
043        extends BaseAbstractEditCommand<SymbolPositionSpec, SymbolPositionEdit, EditSymbolPositionResult, SymbolPosition, SymbolPosition> {
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.SymbolPosition.name(), SecurityRoles.Edit.name())
054                ))
055        ));
056
057        SPEC_FIELD_DEFINITIONS = List.of(
058                new FieldDefinition("SymbolPositionName", FieldType.ENTITY_NAME, true, null, null)
059        );
060
061        EDIT_FIELD_DEFINITIONS = List.of(
062                new FieldDefinition("SymbolPositionName", FieldType.ENTITY_NAME, true, null, null),
063                new FieldDefinition("IsDefault", FieldType.BOOLEAN, true, null, null),
064                new FieldDefinition("SortOrder", FieldType.SIGNED_INTEGER, true, null, null),
065                new FieldDefinition("Description", FieldType.STRING, false, 1L, 132L)
066        );
067    }
068
069    @Inject
070    AccountingControl accountingControl;
071
072    @Inject
073    SymbolPositionLogic symbolPositionLogic;
074
075    /** Creates a new instance of EditSymbolPositionCommand */
076    public EditSymbolPositionCommand() {
077        super(COMMAND_SECURITY_DEFINITION, SPEC_FIELD_DEFINITIONS, EDIT_FIELD_DEFINITIONS);
078    }
079
080    @Override
081    public EditSymbolPositionResult getResult() {
082        return AccountingResultFactory.getEditSymbolPositionResult();
083    }
084
085    @Override
086    public SymbolPositionEdit getEdit() {
087        return AccountingEditFactory.getSymbolPositionEdit();
088    }
089
090    @Override
091    public SymbolPosition getEntity(EditSymbolPositionResult result) {
092        return symbolPositionLogic.getSymbolPositionByName(this, spec.getSymbolPositionName(), editModeToEntityPermission(editMode));
093    }
094
095    @Override
096    public SymbolPosition getLockEntity(SymbolPosition symbolPosition) {
097        return symbolPosition;
098    }
099
100    @Override
101    public void fillInResult(EditSymbolPositionResult result, SymbolPosition symbolPosition) {
102        result.setSymbolPosition(accountingControl.getSymbolPositionTransfer(getUserVisit(), symbolPosition));
103    }
104
105    @Override
106    public void doLock(SymbolPositionEdit edit, SymbolPosition symbolPosition) {
107        var symbolPositionDescription = accountingControl.getSymbolPositionDescription(symbolPosition, getPreferredLanguage());
108        var symbolPositionDetail = symbolPosition.getLastDetail();
109
110        edit.setSymbolPositionName(symbolPositionDetail.getSymbolPositionName());
111        edit.setIsDefault(symbolPositionDetail.getIsDefault().toString());
112        edit.setSortOrder(symbolPositionDetail.getSortOrder().toString());
113
114        if(symbolPositionDescription != null) {
115            edit.setDescription(symbolPositionDescription.getDescription());
116        }
117    }
118
119    @Override
120    public void canUpdate(SymbolPosition symbolPosition) {
121        var symbolPositionName = edit.getSymbolPositionName();
122        var duplicateSymbolPosition = accountingControl.getSymbolPositionByName(symbolPositionName);
123
124        if(duplicateSymbolPosition != null && !symbolPosition.equals(duplicateSymbolPosition)) {
125            addExecutionError(ExecutionErrors.DuplicateSymbolPositionName.name(), symbolPositionName);
126        }
127    }
128
129    @Override
130    public void doUpdate(SymbolPosition symbolPosition) {
131        var partyPK = getPartyPK();
132        var symbolPositionDetailValue = accountingControl.getSymbolPositionDetailValueForUpdate(symbolPosition);
133        var symbolPositionDescription = accountingControl.getSymbolPositionDescriptionForUpdate(symbolPosition, getPreferredLanguage());
134        var description = edit.getDescription();
135
136        symbolPositionDetailValue.setSymbolPositionName(edit.getSymbolPositionName());
137        symbolPositionDetailValue.setIsDefault(Boolean.valueOf(edit.getIsDefault()));
138        symbolPositionDetailValue.setSortOrder(Integer.valueOf(edit.getSortOrder()));
139
140        accountingControl.updateSymbolPositionFromValue(symbolPositionDetailValue, partyPK);
141
142        if(symbolPositionDescription == null && description != null) {
143            accountingControl.createSymbolPositionDescription(symbolPosition, getPreferredLanguage(), description, partyPK);
144        } else if(symbolPositionDescription != null && description == null) {
145            accountingControl.deleteSymbolPositionDescription(symbolPositionDescription, partyPK);
146        } else if(symbolPositionDescription != null && description != null) {
147            var symbolPositionDescriptionValue = accountingControl.getSymbolPositionDescriptionValue(symbolPositionDescription);
148
149            symbolPositionDescriptionValue.setDescription(description);
150            accountingControl.updateSymbolPositionDescriptionFromValue(symbolPositionDescriptionValue, partyPK);
151        }
152    }
153
154}