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.form.CreateLocationDescriptionForm;
020import com.echothree.model.control.party.common.PartyTypes;
021import com.echothree.model.control.party.server.control.PartyControl;
022import com.echothree.model.control.security.common.SecurityRoleGroups;
023import com.echothree.model.control.security.common.SecurityRoles;
024import com.echothree.model.control.warehouse.server.control.WarehouseControl;
025import com.echothree.model.data.user.common.pk.UserVisitPK;
026import com.echothree.util.common.command.BaseResult;
027import com.echothree.util.common.message.ExecutionErrors;
028import com.echothree.util.common.validation.FieldDefinition;
029import com.echothree.util.common.validation.FieldType;
030import com.echothree.util.server.control.BaseSimpleCommand;
031import com.echothree.util.server.control.CommandSecurityDefinition;
032import com.echothree.util.server.control.PartyTypeDefinition;
033import com.echothree.util.server.control.SecurityRoleDefinition;
034import com.echothree.util.server.persistence.Session;
035import java.util.List;
036import javax.enterprise.context.Dependent;
037
038@Dependent
039public class CreateLocationDescriptionCommand
040        extends BaseSimpleCommand<CreateLocationDescriptionForm> {
041
042    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
043    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
044
045    static {
046        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(List.of(
047                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
048                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
049                        new SecurityRoleDefinition(SecurityRoleGroups.Location.name(), SecurityRoles.Description.name())
050                ))
051        ));
052
053        FORM_FIELD_DEFINITIONS = List.of(
054                new FieldDefinition("WarehouseName", FieldType.ENTITY_NAME, true, null, null),
055                new FieldDefinition("LocationName", FieldType.ENTITY_NAME, true, null, null),
056                new FieldDefinition("LanguageIsoName", FieldType.ENTITY_NAME, true, null, null),
057                new FieldDefinition("Description", FieldType.STRING, true, 1L, 132L)
058                );
059    }
060    
061    /** Creates a new instance of CreateLocationDescriptionCommand */
062    public CreateLocationDescriptionCommand() {
063        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
064    }
065    
066    @Override
067    protected BaseResult execute() {
068        var warehouseControl = Session.getModelController(WarehouseControl.class);
069        var warehouseName = form.getWarehouseName();
070        var warehouse = warehouseControl.getWarehouseByName(warehouseName);
071        
072        if(warehouse != null) {
073            var warehouseParty = warehouse.getParty();
074            var locationName = form.getLocationName();
075            var location = warehouseControl.getLocationByName(warehouseParty, locationName);
076            
077            if(location != null) {
078                var partyControl = Session.getModelController(PartyControl.class);
079                var languageIsoName = form.getLanguageIsoName();
080                var language = partyControl.getLanguageByIsoName(languageIsoName);
081                
082                if(language != null) {
083                    var locationDescription = warehouseControl.getLocationDescription(location, language);
084                    
085                    if(locationDescription == null) {
086                        var description = form.getDescription();
087                        
088                        warehouseControl.createLocationDescription(location, language, description, getPartyPK());
089                    } else {
090                        addExecutionError(ExecutionErrors.DuplicateLocationDescription.name());
091                    }
092                } else {
093                    addExecutionError(ExecutionErrors.UnknownLanguageIsoName.name(), languageIsoName);
094                }
095            } else {
096                addExecutionError(ExecutionErrors.UnknownLocationName.name(), locationName);
097            }
098        } else {
099            addExecutionError(ExecutionErrors.UnknownWarehouseName.name(), warehouseName);
100        }
101        
102        return null;
103    }
104    
105}