001// --------------------------------------------------------------------------------
002// Copyright 2002-2025 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;
037import javax.enterprise.context.RequestScoped;
038
039@RequestScoped
040public class CreateEntityGeoPointAttributeCommand
041        extends BaseSimpleCommand<CreateEntityGeoPointAttributeForm> {
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(), null)
050        ));
051
052        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
053                new FieldDefinition("EntityRef", FieldType.ENTITY_REF, false, null, null),
054                new FieldDefinition("Uuid", FieldType.UUID, false, null, null),
055                new FieldDefinition("EntityAttributeName", FieldType.ENTITY_NAME, false, null, null),
056                new FieldDefinition("EntityAttributeUuid", FieldType.UUID, 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() {
068        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
069    }
070    
071    @Override
072    protected BaseResult execute() {
073        var entityInstance = EntityInstanceLogic.getInstance().getEntityInstance(this, form);
074
075        if(!hasExecutionErrors()) {
076            var entityAttribute = EntityAttributeLogic.getInstance().getEntityAttribute(this, entityInstance, form, form,
077                    EntityAttributeTypes.GEOPOINT);
078
079            if(!hasExecutionErrors()) {
080                var unitOfMeasureTypeLogic = UnitOfMeasureTypeLogic.getInstance();
081                var elevation = unitOfMeasureTypeLogic.checkUnitOfMeasure(this, UomConstants.UnitOfMeasureKindUseType_ELEVATION,
082                        form.getElevation(), form.getElevationUnitOfMeasureTypeName(),
083                        null, ExecutionErrors.MissingRequiredElevation.name(), null, ExecutionErrors.MissingRequiredElevationUnitOfMeasureTypeName.name(),
084                        null, ExecutionErrors.UnknownElevationUnitOfMeasureTypeName.name());
085
086                if(!hasExecutionErrors()) {
087                    var altitude = unitOfMeasureTypeLogic.checkUnitOfMeasure(this, UomConstants.UnitOfMeasureKindUseType_ALTITUDE,
088                            form.getAltitude(), form.getAltitudeUnitOfMeasureTypeName(),
089                            null, ExecutionErrors.MissingRequiredAltitude.name(), null, ExecutionErrors.MissingRequiredAltitudeUnitOfMeasureTypeName.name(),
090                            null, ExecutionErrors.UnknownAltitudeUnitOfMeasureTypeName.name());
091
092                    if(!hasExecutionErrors()) {
093                        var latitude = Integer.valueOf(form.getLatitude());
094                        var longitude = Integer.valueOf(form.getLongitude());
095
096                        EntityAttributeLogic.getInstance().createEntityGeoPointAttribute(this, entityAttribute, entityInstance, latitude, longitude, elevation, altitude, getPartyPK());
097                    }
098                }
099            }
100        }
101
102        return null;
103    }
104
105}