001// --------------------------------------------------------------------------------
002// Copyright 2002-2024 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.CreateLocationNameElementDescriptionForm;
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.party.server.entity.Language;
026import com.echothree.model.data.party.server.entity.Party;
027import com.echothree.model.data.user.common.pk.UserVisitPK;
028import com.echothree.model.data.warehouse.server.entity.LocationNameElement;
029import com.echothree.model.data.warehouse.server.entity.LocationNameElementDescription;
030import com.echothree.model.data.warehouse.server.entity.LocationType;
031import com.echothree.model.data.warehouse.server.entity.Warehouse;
032import com.echothree.util.common.command.BaseResult;
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.server.control.BaseSimpleCommand;
037import com.echothree.util.server.control.CommandSecurityDefinition;
038import com.echothree.util.server.control.PartyTypeDefinition;
039import com.echothree.util.server.control.SecurityRoleDefinition;
040import com.echothree.util.server.persistence.Session;
041import java.util.Arrays;
042import java.util.Collections;
043import java.util.List;
044
045public class CreateLocationNameElementDescriptionCommand
046        extends BaseSimpleCommand<CreateLocationNameElementDescriptionForm> {
047
048    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
049    private final static List<FieldDefinition> FORM_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.LocationNameElement.name(), SecurityRoles.Description.name())
056                ))
057        ));
058        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
059                new FieldDefinition("WarehouseName", FieldType.ENTITY_NAME, true, null, null),
060                new FieldDefinition("LocationTypeName", FieldType.ENTITY_NAME, true, null, null),
061                new FieldDefinition("LocationNameElementName", FieldType.ENTITY_NAME, true, null, null),
062                new FieldDefinition("LanguageIsoName", FieldType.ENTITY_NAME, true, null, null),
063                new FieldDefinition("Description", FieldType.STRING, true, 1L, 132L)
064                ));
065    }
066    
067    /** Creates a new instance of CreateLocationNameElementDescriptionCommand */
068    public CreateLocationNameElementDescriptionCommand(UserVisitPK userVisitPK, CreateLocationNameElementDescriptionForm form) {
069        super(userVisitPK, form, COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
070    }
071    
072    @Override
073    protected BaseResult execute() {
074        var warehouseControl = Session.getModelController(WarehouseControl.class);
075        String warehouseName = form.getWarehouseName();
076        Warehouse warehouse = warehouseControl.getWarehouseByName(warehouseName);
077        
078        if(warehouse != null) {
079            Party warehouseParty = warehouse.getParty();
080            String locationTypeName = form.getLocationTypeName();
081            LocationType locationType = warehouseControl.getLocationTypeByName(warehouseParty, locationTypeName);
082            
083            if(locationType != null) {
084                String locationNameElementName = form.getLocationNameElementName();
085                LocationNameElement locationNameElement = warehouseControl.getLocationNameElementByName(locationType, locationNameElementName);
086                
087                if(locationNameElement != null) {
088                    var partyControl = Session.getModelController(PartyControl.class);
089                    String languageIsoName = form.getLanguageIsoName();
090                    Language language = partyControl.getLanguageByIsoName(languageIsoName);
091                    
092                    if(language != null) {
093                        LocationNameElementDescription locationNameElementDescription = warehouseControl.getLocationNameElementDescription(locationNameElement, language);
094                        
095                        if(locationNameElementDescription == null) {
096                            var description = form.getDescription();
097                            
098                            warehouseControl.createLocationNameElementDescription(locationNameElement, language, description, getPartyPK());
099                        } else {
100                            addExecutionError(ExecutionErrors.DuplicateLocationNameElementDescription.name());
101                        }
102                    } else {
103                        addExecutionError(ExecutionErrors.UnknownLanguageIsoName.name(), languageIsoName);
104                    }
105                } else {
106                    addExecutionError(ExecutionErrors.UnknownLocationNameElementName.name(), locationNameElementName);
107                }
108            } else {
109                addExecutionError(ExecutionErrors.UnknownLocationTypeName.name(), locationTypeName);
110            }
111        } else {
112            addExecutionError(ExecutionErrors.UnknownWarehouseName.name(), warehouseName);
113        }
114        
115        return null;
116    }
117    
118}