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.core.server.command;
018
019import com.echothree.control.user.core.common.form.CreateEntityGeoPointAttributeForm;
020import com.echothree.model.control.core.common.EntityAttributeTypes;
021import com.echothree.model.control.core.server.logic.EntityAttributeLogic;
022import com.echothree.model.control.core.server.logic.EntityInstanceLogic;
023import com.echothree.model.control.party.common.PartyTypes;
024import com.echothree.model.control.uom.common.UomConstants;
025import com.echothree.model.control.uom.server.logic.UnitOfMeasureTypeLogic;
026import com.echothree.model.data.user.common.pk.UserVisitPK;
027import com.echothree.util.common.command.BaseResult;
028import com.echothree.util.common.message.ExecutionErrors;
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 java.util.Arrays;
035import java.util.Collections;
036import java.util.List;
037
038public class CreateEntityGeoPointAttributeCommand
039        extends BaseSimpleCommand<CreateEntityGeoPointAttributeForm> {
040
041    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
042    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
043    
044    static {
045        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(List.of(
046                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
047                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), null)
048        ));
049
050        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
051                new FieldDefinition("EntityRef", FieldType.ENTITY_REF, false, null, null),
052                new FieldDefinition("Key", FieldType.KEY, false, null, null),
053                new FieldDefinition("Guid", FieldType.GUID, false, null, null),
054                new FieldDefinition("Ulid", FieldType.ULID, false, null, null),
055                new FieldDefinition("EntityAttributeName", FieldType.ENTITY_NAME, false, null, null),
056                new FieldDefinition("EntityAttributeUlid", FieldType.ULID, false, null, null),
057                new FieldDefinition("Latitude", FieldType.LATITUDE, true, null, null),
058                new FieldDefinition("Longitude", FieldType.LONGITUDE, true, null, null),
059                new FieldDefinition("Elevation", FieldType.UNSIGNED_LONG, false, null, null),
060                new FieldDefinition("ElevationUnitOfMeasureTypeName", FieldType.ENTITY_NAME, false, null, null),
061                new FieldDefinition("Altitude", FieldType.UNSIGNED_LONG, false, null, null),
062                new FieldDefinition("AltitudeUnitOfMeasureTypeName", FieldType.ENTITY_NAME, false, null, null)
063                ));
064    }
065    
066    /** Creates a new instance of CreateEntityGeoPointAttributeCommand */
067    public CreateEntityGeoPointAttributeCommand(UserVisitPK userVisitPK, CreateEntityGeoPointAttributeForm form) {
068        super(userVisitPK, form, COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
069    }
070    
071    @Override
072    protected BaseResult execute() {
073        var parameterCount = EntityInstanceLogic.getInstance().countPossibleEntitySpecs(form);
074
075        if(parameterCount == 1) {
076            var entityInstance = EntityInstanceLogic.getInstance().getEntityInstance(this, form);
077
078            if(!hasExecutionErrors()) {
079                var entityAttributeName = form.getEntityAttributeName();
080                var entityAttributeUlid = form.getEntityAttributeUlid();
081                
082                parameterCount = (entityAttributeName == null ? 0 : 1) + (entityAttributeUlid == null ? 0 : 1);
083                
084                if(parameterCount == 1) {
085                    var entityAttribute = entityAttributeName == null ?
086                            EntityAttributeLogic.getInstance().getEntityAttributeByUlid(this, entityAttributeUlid) :
087                            EntityAttributeLogic.getInstance().getEntityAttributeByName(this, entityInstance.getEntityType(), entityAttributeName);
088
089                    if(!hasExecutionErrors()) {
090                        var entityAttributeTypeName = entityAttribute.getLastDetail().getEntityAttributeType().getEntityAttributeTypeName();
091
092                        if(EntityAttributeTypes.GEOPOINT.name().equals(entityAttributeTypeName)) {
093                            if(entityInstance.getEntityType().equals(entityAttribute.getLastDetail().getEntityType())) {
094                                var coreControl = getCoreControl();
095                                var entityGeoPointAttribute = coreControl.getEntityGeoPointAttribute(entityAttribute, entityInstance);
096
097                                if(entityGeoPointAttribute == null) {
098                                    var unitOfMeasureTypeLogic = UnitOfMeasureTypeLogic.getInstance();
099                                    var elevation = unitOfMeasureTypeLogic.checkUnitOfMeasure(this, UomConstants.UnitOfMeasureKindUseType_ELEVATION,
100                                            form.getElevation(), form.getElevationUnitOfMeasureTypeName(),
101                                            null, ExecutionErrors.MissingRequiredElevation.name(), null, ExecutionErrors.MissingRequiredElevationUnitOfMeasureTypeName.name(),
102                                            null, ExecutionErrors.UnknownElevationUnitOfMeasureTypeName.name());
103
104                                    if(!hasExecutionErrors()) {
105                                        var altitude = unitOfMeasureTypeLogic.checkUnitOfMeasure(this, UomConstants.UnitOfMeasureKindUseType_ALTITUDE,
106                                                form.getAltitude(), form.getAltitudeUnitOfMeasureTypeName(),
107                                                null, ExecutionErrors.MissingRequiredAltitude.name(), null, ExecutionErrors.MissingRequiredAltitudeUnitOfMeasureTypeName.name(),
108                                                null, ExecutionErrors.UnknownAltitudeUnitOfMeasureTypeName.name());
109
110                                        if(!hasExecutionErrors()) {
111                                            var latitude = Integer.valueOf(form.getLatitude());
112                                            var longitude = Integer.valueOf(form.getLongitude());
113
114                                            coreControl.createEntityGeoPointAttribute(entityAttribute, entityInstance, latitude, longitude, elevation, altitude, getPartyPK());
115                                        }
116                                    }
117                                } else {
118                                    addExecutionError(ExecutionErrors.DuplicateEntityGeoPointAttribute.name(),
119                                            EntityInstanceLogic.getInstance().getEntityRefFromEntityInstance(entityInstance),
120                                            entityAttribute.getLastDetail().getEntityAttributeName());
121                                }
122                            } else {
123                                var expectedEntityTypeDetail = entityAttribute.getLastDetail().getEntityType().getLastDetail();
124                                var suppliedEntityTypeDetail = entityInstance.getEntityType().getLastDetail();
125                                
126                                addExecutionError(ExecutionErrors.MismatchedEntityType.name(),
127                                        expectedEntityTypeDetail.getComponentVendor().getLastDetail().getComponentVendorName(),
128                                        expectedEntityTypeDetail.getEntityTypeName(),
129                                        suppliedEntityTypeDetail.getComponentVendor().getLastDetail().getComponentVendorName(),
130                                        suppliedEntityTypeDetail.getEntityTypeName());
131                            }
132                        } else {
133                            addExecutionError(ExecutionErrors.MismatchedEntityAttributeType.name(),
134                                    EntityAttributeTypes.GEOPOINT.name(), entityAttributeTypeName);
135                        }
136                    }
137                } else {
138                    addExecutionError(ExecutionErrors.InvalidParameterCount.name());
139                }
140            }
141        } else {
142            addExecutionError(ExecutionErrors.InvalidParameterCount.name());
143        }
144
145        return null;
146    }
147
148}