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.core.server.command;
018
019import com.echothree.control.user.core.common.edit.CoreEditFactory;
020import com.echothree.control.user.core.common.edit.EntityGeoPointDefaultEdit;
021import com.echothree.control.user.core.common.form.EditEntityGeoPointDefaultForm;
022import com.echothree.control.user.core.common.result.CoreResultFactory;
023import com.echothree.control.user.core.common.result.EditEntityGeoPointDefaultResult;
024import com.echothree.control.user.core.common.spec.EntityGeoPointDefaultSpec;
025import com.echothree.model.control.core.server.logic.EntityAttributeLogic;
026import com.echothree.model.control.party.common.PartyTypes;
027import com.echothree.model.control.uom.common.UomConstants;
028import com.echothree.model.control.uom.server.logic.UnitOfMeasureTypeLogic;
029import com.echothree.model.data.core.server.entity.EntityAttribute;
030import com.echothree.model.data.core.server.entity.EntityGeoPointDefault;
031import com.echothree.model.data.user.common.pk.UserVisitPK;
032import com.echothree.util.common.command.EditMode;
033import com.echothree.util.common.message.ExecutionErrors;
034import com.echothree.util.common.string.GeoPointUtils;
035import com.echothree.util.common.validation.FieldDefinition;
036import com.echothree.util.common.validation.FieldType;
037import com.echothree.util.server.control.BaseAbstractEditCommand;
038import com.echothree.util.server.control.CommandSecurityDefinition;
039import com.echothree.util.server.control.PartyTypeDefinition;
040import java.util.List;
041import javax.enterprise.context.Dependent;
042import javax.inject.Inject;
043
044@Dependent
045public class EditEntityGeoPointDefaultCommand
046        extends BaseAbstractEditCommand<EntityGeoPointDefaultSpec, EntityGeoPointDefaultEdit, EditEntityGeoPointDefaultResult, EntityGeoPointDefault, EntityAttribute> {
047
048    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
049    private final static List<FieldDefinition> SPEC_FIELD_DEFINITIONS;
050    private final static List<FieldDefinition> EDIT_FIELD_DEFINITIONS;
051
052    static {
053        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(List.of(
054                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
055                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), null)
056        ));
057
058        SPEC_FIELD_DEFINITIONS = List.of(
059                new FieldDefinition("EntityRef", FieldType.ENTITY_REF, false, null, null),
060                new FieldDefinition("Uuid", FieldType.UUID, false, null, null),
061                new FieldDefinition("ComponentVendorName", FieldType.ENTITY_NAME, false, null, null),
062                new FieldDefinition("EntityTypeName", FieldType.ENTITY_TYPE_NAME, false, null, null),
063                new FieldDefinition("EntityAttributeName", FieldType.ENTITY_NAME, false, null, null)
064        );
065
066        EDIT_FIELD_DEFINITIONS = List.of(
067                new FieldDefinition("Latitude", FieldType.LATITUDE, true, null, null),
068                new FieldDefinition("Longitude", FieldType.LONGITUDE, true, null, null),
069                new FieldDefinition("Elevation", FieldType.UNSIGNED_LONG, false, null, null),
070                new FieldDefinition("ElevationUnitOfMeasureTypeName", FieldType.ENTITY_NAME, false, null, null),
071                new FieldDefinition("Altitude", FieldType.UNSIGNED_LONG, false, null, null),
072                new FieldDefinition("AltitudeUnitOfMeasureTypeName", FieldType.ENTITY_NAME, false, null, null)
073        );
074    }
075
076    @Inject
077    EntityAttributeLogic entityAttributeLogic;
078
079    @Inject
080    UnitOfMeasureTypeLogic unitOfMeasureTypeLogic;
081
082    /** Creates a new instance of EditEntityGeoPointDefaultCommand */
083    public EditEntityGeoPointDefaultCommand() {
084        super(COMMAND_SECURITY_DEFINITION, SPEC_FIELD_DEFINITIONS, EDIT_FIELD_DEFINITIONS);
085    }
086    
087    @Override
088    public EditEntityGeoPointDefaultResult getResult() {
089        return CoreResultFactory.getEditEntityGeoPointDefaultResult();
090    }
091
092    @Override
093    public EntityGeoPointDefaultEdit getEdit() {
094        return CoreEditFactory.getEntityGeoPointDefaultEdit();
095    }
096
097    @Override
098    public EntityGeoPointDefault getEntity(EditEntityGeoPointDefaultResult result) {
099        var entityAttribute = entityAttributeLogic.getEntityAttributeByUniversalSpec(this, spec);
100        EntityGeoPointDefault entityGeoPointDefault = null;
101
102        if(!hasExecutionErrors()) {
103
104            if(editMode.equals(EditMode.LOCK) || editMode.equals(EditMode.ABANDON)) {
105                entityGeoPointDefault = coreControl.getEntityGeoPointDefault(entityAttribute);
106            } else { // EditMode.UPDATE
107                entityGeoPointDefault = coreControl.getEntityGeoPointDefaultForUpdate(entityAttribute);
108            }
109
110            if(entityGeoPointDefault == null) {
111                addExecutionError(ExecutionErrors.UnknownEntityGeoPointDefault.name());
112            }
113        }
114
115        return entityGeoPointDefault;
116    }
117
118    @Override
119    public EntityAttribute getLockEntity(EntityGeoPointDefault entityGeoPointDefault) {
120        return entityGeoPointDefault.getEntityAttribute();
121    }
122
123    @Override
124    public void fillInResult(EditEntityGeoPointDefaultResult result, EntityGeoPointDefault entityGeoPointDefault) {
125
126        result.setEntityGeoPointDefault(coreControl.getEntityGeoPointDefaultTransfer(getUserVisit(), entityGeoPointDefault));
127    }
128
129    @Override
130    public void doLock(EntityGeoPointDefaultEdit edit, EntityGeoPointDefault entityGeoPointDefault) {
131        var geoPointUtils = GeoPointUtils.getInstance();
132        UnitOfMeasureTypeLogic.StringUnitOfMeasure stringUnitOfMeasure;
133
134        edit.setLatitude(geoPointUtils.formatDegrees(entityGeoPointDefault.getLatitude()));
135        edit.setLongitude(geoPointUtils.formatDegrees(entityGeoPointDefault.getLongitude()));
136        stringUnitOfMeasure = unitOfMeasureTypeLogic.unitOfMeasureToString(this, UomConstants.UnitOfMeasureKindUseType_ELEVATION, entityGeoPointDefault.getElevation());
137        edit.setElevationUnitOfMeasureTypeName(stringUnitOfMeasure.getUnitOfMeasureTypeName());
138        edit.setElevation(stringUnitOfMeasure.getValue());
139        stringUnitOfMeasure = unitOfMeasureTypeLogic.unitOfMeasureToString(this, UomConstants.UnitOfMeasureKindUseType_ALTITUDE, entityGeoPointDefault.getAltitude());
140        edit.setAltitudeUnitOfMeasureTypeName(stringUnitOfMeasure.getUnitOfMeasureTypeName());
141        edit.setAltitude(stringUnitOfMeasure.getValue());
142    }
143
144    Long elevation;
145    Long altitude;
146
147    @Override
148    public void canUpdate(EntityGeoPointDefault entityGeoPointDefault) {
149        elevation = unitOfMeasureTypeLogic.checkUnitOfMeasure(this, UomConstants.UnitOfMeasureKindUseType_ELEVATION,
150                edit.getElevation(), edit.getElevationUnitOfMeasureTypeName(),
151                null, ExecutionErrors.MissingRequiredElevation.name(), null, ExecutionErrors.MissingRequiredElevationUnitOfMeasureTypeName.name(),
152                null, ExecutionErrors.UnknownElevationUnitOfMeasureTypeName.name());
153
154        altitude = unitOfMeasureTypeLogic.checkUnitOfMeasure(this, UomConstants.UnitOfMeasureKindUseType_ALTITUDE,
155                edit.getAltitude(), edit.getAltitudeUnitOfMeasureTypeName(),
156                null, ExecutionErrors.MissingRequiredAltitude.name(), null, ExecutionErrors.MissingRequiredAltitudeUnitOfMeasureTypeName.name(),
157                null, ExecutionErrors.UnknownAltitudeUnitOfMeasureTypeName.name());
158    }
159
160    @Override
161    public void doUpdate(EntityGeoPointDefault entityGeoPointDefault) {
162        var entityGeoPointDefaultValue = coreControl.getEntityGeoPointDefaultValueForUpdate(entityGeoPointDefault);
163
164        entityGeoPointDefaultValue.setLatitude(Integer.valueOf(edit.getLatitude()));
165        entityGeoPointDefaultValue.setLongitude(Integer.valueOf(edit.getLongitude()));
166        entityGeoPointDefaultValue.setElevation(elevation);
167        entityGeoPointDefaultValue.setAltitude(altitude);
168
169        coreControl.updateEntityGeoPointDefaultFromValue(entityGeoPointDefaultValue, getPartyPK());
170    }
171    
172}