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.warehouse.server.command;
018
019import com.echothree.control.user.warehouse.common.edit.LocationNameElementDescriptionEdit;
020import com.echothree.control.user.warehouse.common.edit.WarehouseEditFactory;
021import com.echothree.control.user.warehouse.common.result.WarehouseResultFactory;
022import com.echothree.control.user.warehouse.common.spec.LocationNameElementDescriptionSpec;
023import com.echothree.model.control.party.common.PartyTypes;
024import com.echothree.model.control.party.server.control.PartyControl;
025import com.echothree.model.control.security.common.SecurityRoleGroups;
026import com.echothree.model.control.security.common.SecurityRoles;
027import com.echothree.model.control.warehouse.server.control.WarehouseControl;
028import com.echothree.util.common.command.BaseResult;
029import com.echothree.util.common.command.EditMode;
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.BaseEditCommand;
034import com.echothree.util.server.control.CommandSecurityDefinition;
035import com.echothree.util.server.control.PartyTypeDefinition;
036import com.echothree.util.server.control.SecurityRoleDefinition;
037import com.echothree.util.server.persistence.Session;
038import java.util.List;
039import javax.enterprise.context.Dependent;
040
041@Dependent
042public class EditLocationNameElementDescriptionCommand
043        extends BaseEditCommand<LocationNameElementDescriptionSpec, LocationNameElementDescriptionEdit> {
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.LocationNameElement.name(), SecurityRoles.Description.name())
054                ))
055        ));
056
057        SPEC_FIELD_DEFINITIONS = List.of(
058                new FieldDefinition("WarehouseName", FieldType.ENTITY_NAME, true, null, null),
059                new FieldDefinition("LocationTypeName", FieldType.ENTITY_NAME, true, null, null),
060                new FieldDefinition("LocationNameElementName", 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    /** Creates a new instance of EditLocationNameElementDescriptionCommand */
070    public EditLocationNameElementDescriptionCommand() {
071        super(COMMAND_SECURITY_DEFINITION, SPEC_FIELD_DEFINITIONS, EDIT_FIELD_DEFINITIONS);
072    }
073    
074    @Override
075    protected BaseResult execute() {
076        var warehouseControl = Session.getModelController(WarehouseControl.class);
077        var result = WarehouseResultFactory.getEditLocationNameElementDescriptionResult();
078        var warehouseName = spec.getWarehouseName();
079        var warehouse = warehouseControl.getWarehouseByName(warehouseName);
080        
081        if(warehouse != null) {
082            var warehouseParty = warehouse.getParty();
083            var locationTypeName = spec.getLocationTypeName();
084            var locationType = warehouseControl.getLocationTypeByName(warehouseParty, locationTypeName);
085            
086            if(locationType != null) {
087                var locationNameElementName = spec.getLocationNameElementName();
088                var locationNameElement = warehouseControl.getLocationNameElementByName(locationType, locationNameElementName);
089                
090                if(locationNameElement != null) {
091                    var partyControl = Session.getModelController(PartyControl.class);
092                    var languageIsoName = spec.getLanguageIsoName();
093                    var language = partyControl.getLanguageByIsoName(languageIsoName);
094                    
095                    if(language != null) {
096                        if(editMode.equals(EditMode.LOCK)) {
097                            var locationTypeDescription = warehouseControl.getLocationNameElementDescription(locationNameElement, language);
098                            
099                            if(locationTypeDescription != null) {
100                                result.setLocationNameElementDescription(warehouseControl.getLocationNameElementDescriptionTransfer(getUserVisit(), locationTypeDescription));
101                                
102                                if(lockEntity(locationType)) {
103                                    var edit = WarehouseEditFactory.getLocationNameElementDescriptionEdit();
104                                    
105                                    result.setEdit(edit);
106                                    edit.setDescription(locationTypeDescription.getDescription());
107                                } else {
108                                    addExecutionError(ExecutionErrors.EntityLockFailed.name());
109                                }
110                                
111                                result.setEntityLock(getEntityLockTransfer(locationType));
112                            } else {
113                                addExecutionError(ExecutionErrors.UnknownLocationNameElementDescription.name());
114                            }
115                        } else if(editMode.equals(EditMode.UPDATE)) {
116                            var locationTypeDescriptionValue = warehouseControl.getLocationNameElementDescriptionValueForUpdate(locationNameElement, language);
117                            
118                            if(locationTypeDescriptionValue != null) {
119                                if(lockEntityForUpdate(locationType)) {
120                                    try {
121                                        var description = edit.getDescription();
122                                        
123                                        locationTypeDescriptionValue.setDescription(description);
124                                        
125                                        warehouseControl.updateLocationNameElementDescriptionFromValue(locationTypeDescriptionValue, getPartyPK());
126                                    } finally {
127                                        unlockEntity(locationType);
128                                    }
129                                } else {
130                                    addExecutionError(ExecutionErrors.EntityLockStale.name());
131                                }
132                            } else {
133                                addExecutionError(ExecutionErrors.UnknownLocationNameElementDescription.name());
134                            }
135                        }
136                    } else {
137                        addExecutionError(ExecutionErrors.UnknownLanguageIsoName.name(), languageIsoName);
138                    }
139                } else {
140                    addExecutionError(ExecutionErrors.UnknownLocationNameElementName.name(), locationNameElementName);
141                }
142            } else {
143                addExecutionError(ExecutionErrors.UnknownLocationTypeName.name(), locationTypeName);
144            }
145        } else {
146            addExecutionError(ExecutionErrors.UnknownWarehouseName.name(), warehouseName);
147        }
148        
149        return result;
150    }
151    
152}