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