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.CreateLocationNameElementForm;
020import com.echothree.control.user.warehouse.common.result.WarehouseResultFactory;
021import com.echothree.model.control.party.common.PartyTypes;
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.persistence.BasePK;
029import com.echothree.util.common.validation.FieldDefinition;
030import com.echothree.util.common.validation.FieldType;
031import com.echothree.util.server.control.BaseSimpleCommand;
032import com.echothree.util.server.control.CommandSecurityDefinition;
033import com.echothree.util.server.control.PartyTypeDefinition;
034import com.echothree.util.server.control.SecurityRoleDefinition;
035import java.util.List;
036import javax.enterprise.context.Dependent;
037import javax.inject.Inject;
038
039@Dependent
040public class CreateLocationNameElementCommand
041        extends BaseSimpleCommand<CreateLocationNameElementForm> {
042
043    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
044    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
045
046    static {
047        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(List.of(
048                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
049                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
050                        new SecurityRoleDefinition(SecurityRoleGroups.LocationNameElement.name(), SecurityRoles.Create.name())
051                ))
052        ));
053
054        FORM_FIELD_DEFINITIONS = List.of(
055                new FieldDefinition("WarehouseName", FieldType.ENTITY_NAME, true, null, null),
056                new FieldDefinition("LocationTypeName", FieldType.ENTITY_NAME, true, null, null),
057                new FieldDefinition("LocationNameElementName", FieldType.ENTITY_NAME, true, null, null),
058                new FieldDefinition("Offset", FieldType.UNSIGNED_INTEGER, true, null, null),
059                new FieldDefinition("Length", FieldType.UNSIGNED_INTEGER, true, null, null),
060                new FieldDefinition("ValidationPattern", FieldType.REGULAR_EXPRESSION, false, null, null),
061                new FieldDefinition("Description", FieldType.STRING, false, 1L, 132L)
062        );
063    }
064
065    @Inject
066    WarehouseControl warehouseControl;
067
068    
069    /** Creates a new instance of CreateLocationNameElementCommand */
070    public CreateLocationNameElementCommand() {
071        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
072    }
073    
074    @Override
075    protected BaseResult execute() {
076        var result = WarehouseResultFactory.getCreateLocationNameElementResult();
077        var warehouseName = form.getWarehouseName();
078        var warehouse = warehouseControl.getWarehouseByName(warehouseName);
079        
080        if(warehouse != null) {
081            var warehouseParty = warehouse.getParty();
082            var locationTypeName = form.getLocationTypeName();
083            var locationType = warehouseControl.getLocationTypeByName(warehouseParty, locationTypeName);
084            
085            if(locationType != null) {
086                var locationNameElementName = form.getLocationNameElementName();
087                var locationNameElement = warehouseControl.getLocationNameElementByName(locationType,
088                        locationNameElementName);
089                
090                if(locationNameElement == null) {
091                    BasePK createdBy = getPartyPK();
092                    var offset = Integer.valueOf(form.getOffset());
093                    var length = Integer.valueOf(form.getLength());
094                    var validationPattern = form.getValidationPattern();
095                    var description = form.getDescription();
096                    
097                    locationNameElement = warehouseControl.createLocationNameElement(locationType, locationNameElementName, offset,
098                            length, validationPattern, createdBy);
099                    
100                    if(description != null) {
101                        warehouseControl.createLocationNameElementDescription(locationNameElement, getPreferredLanguage(),
102                                description, createdBy);
103                    }
104                } else {
105                    addExecutionError(ExecutionErrors.DuplicateLocationNameElementName.name(), locationNameElementName);
106                }
107
108                if(locationNameElement != null) {
109                    result.setEntityRef(locationNameElement.getPrimaryKey().getEntityRef());
110                    result.setWarehouseName(warehouse.getWarehouseName());
111                    result.setLocationTypeName(locationType.getLastDetail().getLocationTypeName());
112                    result.setLocationNameElementName(locationNameElement.getLastDetail().getLocationNameElementName());
113                }
114            } else {
115                addExecutionError(ExecutionErrors.UnknownLocationTypeName.name(), locationTypeName);
116            }
117        } else {
118            addExecutionError(ExecutionErrors.UnknownWarehouseName.name(), warehouseName);
119        }
120        
121        return result;
122    }
123    
124}