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.item.server.command;
018
019import com.echothree.control.user.item.common.edit.ItemCategoryDescriptionEdit;
020import com.echothree.control.user.item.common.edit.ItemEditFactory;
021import com.echothree.control.user.item.common.form.EditItemCategoryDescriptionForm;
022import com.echothree.control.user.item.common.result.EditItemCategoryDescriptionResult;
023import com.echothree.control.user.item.common.result.ItemResultFactory;
024import com.echothree.control.user.item.common.spec.ItemCategoryDescriptionSpec;
025import com.echothree.model.control.item.server.control.ItemControl;
026import com.echothree.model.control.party.common.PartyTypes;
027import com.echothree.model.control.party.server.control.PartyControl;
028import com.echothree.model.control.security.common.SecurityRoleGroups;
029import com.echothree.model.control.security.common.SecurityRoles;
030import com.echothree.model.data.item.server.entity.ItemCategory;
031import com.echothree.model.data.item.server.entity.ItemCategoryDescription;
032import com.echothree.model.data.user.common.pk.UserVisitPK;
033import com.echothree.util.common.message.ExecutionErrors;
034import com.echothree.util.common.validation.FieldDefinition;
035import com.echothree.util.common.validation.FieldType;
036import com.echothree.util.common.command.EditMode;
037import com.echothree.util.server.control.BaseAbstractEditCommand;
038import com.echothree.util.server.control.CommandSecurityDefinition;
039import com.echothree.util.server.control.PartyTypeDefinition;
040import com.echothree.util.server.control.SecurityRoleDefinition;
041import java.util.List;
042import javax.enterprise.context.Dependent;
043import javax.inject.Inject;
044
045@Dependent
046public class EditItemCategoryDescriptionCommand
047        extends BaseAbstractEditCommand<ItemCategoryDescriptionSpec, ItemCategoryDescriptionEdit, EditItemCategoryDescriptionResult, ItemCategoryDescription, ItemCategory> {
048    
049    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
050    private final static List<FieldDefinition> SPEC_FIELD_DEFINITIONS;
051    private final static List<FieldDefinition> EDIT_FIELD_DEFINITIONS;
052    
053    static {
054        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(List.of(
055                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
056                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
057                        new SecurityRoleDefinition(SecurityRoleGroups.ItemCategory.name(), SecurityRoles.Description.name())
058                ))
059        ));
060        
061        SPEC_FIELD_DEFINITIONS = List.of(
062                new FieldDefinition("ItemCategoryName", FieldType.ENTITY_NAME, true, null, null),
063                new FieldDefinition("LanguageIsoName", FieldType.ENTITY_NAME, true, null, null)
064        );
065        
066        EDIT_FIELD_DEFINITIONS = List.of(
067                new FieldDefinition("Description", FieldType.STRING, true, 1L, 132L)
068        );
069    }
070
071    @Inject
072    ItemControl itemControl;
073
074    @Inject
075    PartyControl partyControl;
076
077    
078    /** Creates a new instance of EditItemCategoryDescriptionCommand */
079    public EditItemCategoryDescriptionCommand() {
080        super(COMMAND_SECURITY_DEFINITION, SPEC_FIELD_DEFINITIONS, EDIT_FIELD_DEFINITIONS);
081    }
082
083    @Override
084    public EditItemCategoryDescriptionResult getResult() {
085        return ItemResultFactory.getEditItemCategoryDescriptionResult();
086    }
087
088    @Override
089    public ItemCategoryDescriptionEdit getEdit() {
090        return ItemEditFactory.getItemCategoryDescriptionEdit();
091    }
092
093    @Override
094    public ItemCategoryDescription getEntity(EditItemCategoryDescriptionResult result) {
095        ItemCategoryDescription itemCategoryDescription = null;
096        var itemCategoryName = spec.getItemCategoryName();
097        var itemCategory = itemControl.getItemCategoryByName(itemCategoryName);
098
099        if(itemCategory != null) {
100            var languageIsoName = spec.getLanguageIsoName();
101            var language = partyControl.getLanguageByIsoName(languageIsoName);
102
103            if(language != null) {
104                if(editMode.equals(EditMode.LOCK) || editMode.equals(EditMode.ABANDON)) {
105                    itemCategoryDescription = itemControl.getItemCategoryDescription(itemCategory, language);
106                } else { // EditMode.UPDATE
107                    itemCategoryDescription = itemControl.getItemCategoryDescriptionForUpdate(itemCategory, language);
108                }
109
110                if(itemCategoryDescription == null) {
111                    addExecutionError(ExecutionErrors.UnknownItemCategoryDescription.name(), itemCategoryName, languageIsoName);
112                }
113            } else {
114                addExecutionError(ExecutionErrors.UnknownLanguageIsoName.name(), languageIsoName);
115            }
116        } else {
117            addExecutionError(ExecutionErrors.UnknownItemCategoryName.name(), itemCategoryName);
118        }
119
120        return itemCategoryDescription;
121    }
122
123    @Override
124    public ItemCategory getLockEntity(ItemCategoryDescription itemCategoryDescription) {
125        return itemCategoryDescription.getItemCategory();
126    }
127
128    @Override
129    public void fillInResult(EditItemCategoryDescriptionResult result, ItemCategoryDescription itemCategoryDescription) {
130        result.setItemCategoryDescription(itemControl.getItemCategoryDescriptionTransfer(getUserVisit(), itemCategoryDescription));
131    }
132
133    @Override
134    public void doLock(ItemCategoryDescriptionEdit edit, ItemCategoryDescription itemCategoryDescription) {
135        edit.setDescription(itemCategoryDescription.getDescription());
136    }
137
138    @Override
139    public void doUpdate(ItemCategoryDescription itemCategoryDescription) {
140        var itemCategoryDescriptionValue = itemControl.getItemCategoryDescriptionValue(itemCategoryDescription);
141        
142        itemCategoryDescriptionValue.setDescription(edit.getDescription());
143        
144        itemControl.updateItemCategoryDescriptionFromValue(itemCategoryDescriptionValue, getPartyPK());
145    }
146
147    
148}