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.EntityGeoPointAttributeEdit;
021import com.echothree.control.user.core.common.form.EditEntityGeoPointAttributeForm;
022import com.echothree.control.user.core.common.result.CoreResultFactory;
023import com.echothree.control.user.core.common.spec.EntityGeoPointAttributeSpec;
024import com.echothree.model.control.core.server.logic.EntityAttributeLogic;
025import com.echothree.model.control.core.server.logic.EntityInstanceLogic;
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.EntityGeoPointAttribute;
030import com.echothree.model.data.user.common.pk.UserVisitPK;
031import com.echothree.util.common.command.BaseResult;
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.BaseEditCommand;
038import com.echothree.util.server.control.CommandSecurityDefinition;
039import com.echothree.util.server.control.PartyTypeDefinition;
040import com.echothree.util.server.persistence.PersistenceUtils;
041import java.util.List;
042import javax.enterprise.context.Dependent;
043
044@Dependent
045public class EditEntityGeoPointAttributeCommand
046        extends BaseEditCommand<EntityGeoPointAttributeSpec, EntityGeoPointAttributeEdit> {
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("EntityAttributeName", FieldType.ENTITY_NAME, false, null, null),
062                new FieldDefinition("EntityAttributeUuid", FieldType.UUID, false, null, null)
063                );
064        
065        EDIT_FIELD_DEFINITIONS = List.of(
066                new FieldDefinition("Latitude", FieldType.LATITUDE, true, null, null),
067                new FieldDefinition("Longitude", FieldType.LONGITUDE, true, null, null),
068                new FieldDefinition("Elevation", FieldType.UNSIGNED_LONG, false, null, null),
069                new FieldDefinition("ElevationUnitOfMeasureTypeName", FieldType.ENTITY_NAME, false, null, null),
070                new FieldDefinition("Altitude", FieldType.UNSIGNED_LONG, false, null, null),
071                new FieldDefinition("AltitudeUnitOfMeasureTypeName", FieldType.ENTITY_NAME, false, null, null)
072
073                );
074    }
075    
076    /** Creates a new instance of EditEntityGeoPointAttributeCommand */
077    public EditEntityGeoPointAttributeCommand() {
078        super(COMMAND_SECURITY_DEFINITION, SPEC_FIELD_DEFINITIONS, EDIT_FIELD_DEFINITIONS);
079    }
080    
081    @Override
082    protected BaseResult execute() {
083        var result = CoreResultFactory.getEditEntityGeoPointAttributeResult();
084        var parameterCount = EntityInstanceLogic.getInstance().countPossibleEntitySpecs(spec);
085
086        if(parameterCount == 1) {
087            var entityInstance = EntityInstanceLogic.getInstance().getEntityInstance(this, spec);
088
089            if(!hasExecutionErrors()) {
090                var entityAttributeName = spec.getEntityAttributeName();
091                var entityAttributeUuid = spec.getEntityAttributeUuid();
092
093                parameterCount = (entityAttributeName == null ? 0 : 1) + (entityAttributeUuid == null ? 0 : 1);
094
095                if(parameterCount == 1) {
096                    var entityAttribute = entityAttributeName == null ?
097                            EntityAttributeLogic.getInstance().getEntityAttributeByUuid(this, entityAttributeUuid) :
098                            EntityAttributeLogic.getInstance().getEntityAttributeByName(this, entityInstance.getEntityType(), entityAttributeName);
099
100                    if(!hasExecutionErrors()) {
101                        if(entityInstance.getEntityType().equals(entityAttribute.getLastDetail().getEntityType())) {
102                            EntityGeoPointAttribute entityGeoPointAttribute = null;
103                            var basePK = PersistenceUtils.getInstance().getBasePKFromEntityInstance(entityInstance);
104
105                            if(editMode.equals(EditMode.LOCK) || editMode.equals(EditMode.ABANDON)) {
106                                entityGeoPointAttribute = coreControl.getEntityGeoPointAttribute(entityAttribute, entityInstance);
107
108                                if(entityGeoPointAttribute != null) {
109                                    if(editMode.equals(EditMode.LOCK)) {
110                                        result.setEntityGeoPointAttribute(coreControl.getEntityGeoPointAttributeTransfer(getUserVisit(), entityGeoPointAttribute, entityInstance));
111
112                                        if(lockEntity(basePK)) {
113                                            var unitOfMeasureTypeLogic = UnitOfMeasureTypeLogic.getInstance();
114                                            var geoPointUtils = GeoPointUtils.getInstance();
115                                            var edit = CoreEditFactory.getEntityGeoPointAttributeEdit();
116                                            UnitOfMeasureTypeLogic.StringUnitOfMeasure stringUnitOfMeasure;
117
118                                            result.setEdit(edit);
119                                            edit.setLatitude(geoPointUtils.formatDegrees(entityGeoPointAttribute.getLatitude()));
120                                            edit.setLongitude(geoPointUtils.formatDegrees(entityGeoPointAttribute.getLongitude()));
121                                            stringUnitOfMeasure = unitOfMeasureTypeLogic.unitOfMeasureToString(this, UomConstants.UnitOfMeasureKindUseType_ELEVATION, entityGeoPointAttribute.getElevation());
122                                            edit.setElevationUnitOfMeasureTypeName(stringUnitOfMeasure.getUnitOfMeasureTypeName());
123                                            edit.setElevation(stringUnitOfMeasure.getValue());
124                                            stringUnitOfMeasure = unitOfMeasureTypeLogic.unitOfMeasureToString(this, UomConstants.UnitOfMeasureKindUseType_ALTITUDE, entityGeoPointAttribute.getAltitude());
125                                            edit.setAltitudeUnitOfMeasureTypeName(stringUnitOfMeasure.getUnitOfMeasureTypeName());
126                                            edit.setAltitude(stringUnitOfMeasure.getValue());
127                                        } else {
128                                            addExecutionError(ExecutionErrors.EntityLockFailed.name());
129                                        }
130                                    } else { // EditMode.ABANDON
131                                        unlockEntity(basePK);
132                                        basePK = null;
133                                    }
134                                } else {
135                                    addExecutionError(ExecutionErrors.UnknownEntityGeoPointAttribute.name(),
136                                            EntityInstanceLogic.getInstance().getEntityRefFromEntityInstance(entityInstance),
137                                            entityAttribute.getLastDetail().getEntityAttributeName());
138                                }
139                            } else if(editMode.equals(EditMode.UPDATE)) {
140                                entityGeoPointAttribute = coreControl.getEntityGeoPointAttributeForUpdate(entityAttribute, entityInstance);
141
142                                if(entityGeoPointAttribute != null) {
143                                    var unitOfMeasureTypeLogic = UnitOfMeasureTypeLogic.getInstance();
144
145                                    var elevation = unitOfMeasureTypeLogic.checkUnitOfMeasure(this, UomConstants.UnitOfMeasureKindUseType_ELEVATION,
146                                            edit.getElevation(), edit.getElevationUnitOfMeasureTypeName(),
147                                            null, ExecutionErrors.MissingRequiredElevation.name(), null, ExecutionErrors.MissingRequiredElevationUnitOfMeasureTypeName.name(),
148                                            null, ExecutionErrors.UnknownElevationUnitOfMeasureTypeName.name());
149
150                                    if(!hasExecutionErrors()) {
151                                        var altitude = unitOfMeasureTypeLogic.checkUnitOfMeasure(this, UomConstants.UnitOfMeasureKindUseType_ALTITUDE,
152                                                edit.getAltitude(), edit.getAltitudeUnitOfMeasureTypeName(),
153                                                null, ExecutionErrors.MissingRequiredAltitude.name(), null, ExecutionErrors.MissingRequiredAltitudeUnitOfMeasureTypeName.name(),
154                                                null, ExecutionErrors.UnknownAltitudeUnitOfMeasureTypeName.name());
155
156                                        if(!hasExecutionErrors()) {
157                                            if(lockEntityForUpdate(basePK)) {
158                                                try {
159                                                    var entityGeoPointAttributeValue = coreControl.getEntityGeoPointAttributeValueForUpdate(entityGeoPointAttribute);
160
161                                                    entityGeoPointAttributeValue.setLatitude(Integer.valueOf(edit.getLatitude()));
162                                                    entityGeoPointAttributeValue.setLongitude(Integer.valueOf(edit.getLongitude()));
163                                                    entityGeoPointAttributeValue.setElevation(elevation);
164                                                    entityGeoPointAttributeValue.setAltitude(altitude);
165
166                                                    coreControl.updateEntityGeoPointAttributeFromValue(entityGeoPointAttributeValue, getPartyPK());
167                                                } finally {
168                                                    unlockEntity(basePK);
169                                                    basePK = null;
170                                                }
171                                            } else {
172                                                addExecutionError(ExecutionErrors.EntityLockStale.name());
173                                            }
174                                        }
175                                    }
176                                } else {
177                                    addExecutionError(ExecutionErrors.UnknownEntityGeoPointAttribute.name(),
178                                            EntityInstanceLogic.getInstance().getEntityRefFromEntityInstance(entityInstance),
179                                            entityAttribute.getLastDetail().getEntityAttributeName());
180                                }
181                            }
182
183                            if(basePK != null) {
184                                result.setEntityLock(getEntityLockTransfer(basePK));
185                            }
186
187                            if(entityGeoPointAttribute != null) {
188                                result.setEntityGeoPointAttribute(coreControl.getEntityGeoPointAttributeTransfer(getUserVisit(), entityGeoPointAttribute, entityInstance));
189                            }
190                        } else {
191                            addExecutionError(ExecutionErrors.MismatchedEntityType.name());
192                        }
193                    }
194                } else {
195                    addExecutionError(ExecutionErrors.InvalidParameterCount.name());
196                }
197            }
198        } else {
199            addExecutionError(ExecutionErrors.InvalidParameterCount.name());
200        }
201
202        return result;
203    }
204    
205}