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.inventory.server.command;
018
019import com.echothree.control.user.inventory.common.edit.InventoryConditionDescriptionEdit;
020import com.echothree.control.user.inventory.common.edit.InventoryEditFactory;
021import com.echothree.control.user.inventory.common.result.EditInventoryConditionDescriptionResult;
022import com.echothree.control.user.inventory.common.result.InventoryResultFactory;
023import com.echothree.control.user.inventory.common.spec.InventoryConditionDescriptionSpec;
024import com.echothree.model.control.inventory.server.control.InventoryConditionControl;
025import com.echothree.model.control.party.common.PartyTypes;
026import com.echothree.model.control.party.server.control.PartyControl;
027import com.echothree.model.control.security.common.SecurityRoleGroups;
028import com.echothree.model.control.security.common.SecurityRoles;
029import com.echothree.model.data.inventory.server.entity.InventoryCondition;
030import com.echothree.model.data.inventory.server.entity.InventoryConditionDescription;
031import com.echothree.util.common.command.EditMode;
032import com.echothree.util.common.message.ExecutionErrors;
033import com.echothree.util.common.validation.FieldDefinition;
034import com.echothree.util.common.validation.FieldType;
035import com.echothree.util.server.control.BaseAbstractEditCommand;
036import com.echothree.util.server.control.CommandSecurityDefinition;
037import com.echothree.util.server.control.PartyTypeDefinition;
038import com.echothree.util.server.control.SecurityRoleDefinition;
039import java.util.List;
040import javax.enterprise.context.Dependent;
041import javax.inject.Inject;
042
043@Dependent
044public class EditInventoryConditionDescriptionCommand
045        extends BaseAbstractEditCommand<InventoryConditionDescriptionSpec, InventoryConditionDescriptionEdit, EditInventoryConditionDescriptionResult, InventoryConditionDescription, InventoryCondition> {
046
047    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
048    private final static List<FieldDefinition> SPEC_FIELD_DEFINITIONS;
049    private final static List<FieldDefinition> EDIT_FIELD_DEFINITIONS;
050
051    static {
052        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(List.of(
053                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
054                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
055                        new SecurityRoleDefinition(SecurityRoleGroups.InventoryCondition.name(), SecurityRoles.Description.name())
056                ))
057        ));
058
059        SPEC_FIELD_DEFINITIONS = List.of(
060                new FieldDefinition("InventoryConditionName", FieldType.ENTITY_NAME, true, null, null),
061                new FieldDefinition("LanguageIsoName", FieldType.ENTITY_NAME, true, null, null)
062        );
063
064        EDIT_FIELD_DEFINITIONS = List.of(
065                new FieldDefinition("Description", FieldType.STRING, true, 1L, 132L)
066        );
067    }
068
069    @Inject
070    InventoryConditionControl inventoryConditionControl;
071
072    @Inject
073    PartyControl partyControl;
074
075    /** Creates a new instance of EditInventoryConditionDescriptionCommand */
076    public EditInventoryConditionDescriptionCommand() {
077        super(COMMAND_SECURITY_DEFINITION, SPEC_FIELD_DEFINITIONS, EDIT_FIELD_DEFINITIONS);
078    }
079    @Override
080    public EditInventoryConditionDescriptionResult getResult() {
081        return InventoryResultFactory.getEditInventoryConditionDescriptionResult();
082    }
083
084    @Override
085    public InventoryConditionDescriptionEdit getEdit() {
086        return InventoryEditFactory.getInventoryConditionDescriptionEdit();
087    }
088
089    @Override
090    public InventoryConditionDescription getEntity(EditInventoryConditionDescriptionResult result) {
091        InventoryConditionDescription inventoryConditionDescription = null;
092        var inventoryConditionName = spec.getInventoryConditionName();
093        var inventoryCondition = inventoryConditionControl.getInventoryConditionByName(inventoryConditionName);
094
095        if(inventoryCondition != null) {
096            var languageIsoName = spec.getLanguageIsoName();
097            var language = partyControl.getLanguageByIsoName(languageIsoName);
098
099            if(language != null) {
100                if(editMode.equals(EditMode.LOCK) || editMode.equals(EditMode.ABANDON)) {
101                    inventoryConditionDescription = inventoryConditionControl.getInventoryConditionDescription(inventoryCondition, language);
102                } else { // EditMode.UPDATE
103                    inventoryConditionDescription = inventoryConditionControl.getInventoryConditionDescriptionForUpdate(inventoryCondition, language);
104                }
105
106                if(inventoryConditionDescription == null) {
107                    addExecutionError(ExecutionErrors.UnknownInventoryConditionDescription.name(), inventoryConditionName, languageIsoName);
108                }
109            } else {
110                addExecutionError(ExecutionErrors.UnknownLanguageIsoName.name(), languageIsoName);
111            }
112        } else {
113            addExecutionError(ExecutionErrors.UnknownInventoryConditionName.name(), inventoryConditionName);
114        }
115
116        return inventoryConditionDescription;
117    }
118
119    @Override
120    public InventoryCondition getLockEntity(InventoryConditionDescription inventoryConditionDescription) {
121        return inventoryConditionDescription.getInventoryCondition();
122    }
123
124    @Override
125    public void fillInResult(EditInventoryConditionDescriptionResult result, InventoryConditionDescription inventoryConditionDescription) {
126        result.setInventoryConditionDescription(inventoryConditionControl.getInventoryConditionDescriptionTransfer(getUserVisit(), inventoryConditionDescription));
127    }
128
129    @Override
130    public void doLock(InventoryConditionDescriptionEdit edit, InventoryConditionDescription inventoryConditionDescription) {
131        edit.setDescription(inventoryConditionDescription.getDescription());
132    }
133
134    @Override
135    public void doUpdate(InventoryConditionDescription inventoryConditionDescription) {
136        var inventoryConditionDescriptionValue = inventoryConditionControl.getInventoryConditionDescriptionValue(inventoryConditionDescription);
137
138        inventoryConditionDescriptionValue.setDescription(edit.getDescription());
139
140        inventoryConditionControl.updateInventoryConditionDescriptionFromValue(inventoryConditionDescriptionValue, getPartyPK());
141    }
142
143}