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;
043import javax.inject.Inject;
044
045@Dependent
046public class EditEntityGeoPointAttributeCommand
047        extends BaseEditCommand<EntityGeoPointAttributeSpec, EntityGeoPointAttributeEdit> {
048
049    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
050    private final static List<FieldDefinition> SPEC_FIELD_DEFINITIONS;
051    private final static List<FieldDefinition> EDIT_FIELD_DEFINITIONS;
052    
053    static {
054        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(List.of(
055                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
056                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), null)
057        ));
058
059        SPEC_FIELD_DEFINITIONS = List.of(
060                new FieldDefinition("EntityRef", FieldType.ENTITY_REF, false, null, null),
061                new FieldDefinition("Uuid", FieldType.UUID, false, null, null),
062                new FieldDefinition("EntityAttributeName", FieldType.ENTITY_NAME, false, null, null),
063                new FieldDefinition("EntityAttributeUuid", FieldType.UUID, 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    EntityInstanceLogic entityInstanceLogic;
081
082    @Inject
083    UnitOfMeasureTypeLogic unitOfMeasureTypeLogic;
084
085    
086    /** Creates a new instance of EditEntityGeoPointAttributeCommand */
087    public EditEntityGeoPointAttributeCommand() {
088        super(COMMAND_SECURITY_DEFINITION, SPEC_FIELD_DEFINITIONS, EDIT_FIELD_DEFINITIONS);
089    }
090    
091    @Override
092    protected BaseResult execute() {
093        var result = CoreResultFactory.getEditEntityGeoPointAttributeResult();
094        var parameterCount = entityInstanceLogic.countPossibleEntitySpecs(spec);
095
096        if(parameterCount == 1) {
097            var entityInstance = entityInstanceLogic.getEntityInstance(this, spec);
098
099            if(!hasExecutionErrors()) {
100                var entityAttributeName = spec.getEntityAttributeName();
101                var entityAttributeUuid = spec.getEntityAttributeUuid();
102
103                parameterCount = (entityAttributeName == null ? 0 : 1) + (entityAttributeUuid == null ? 0 : 1);
104
105                if(parameterCount == 1) {
106                    var entityAttribute = entityAttributeName == null ?
107                            entityAttributeLogic.getEntityAttributeByUuid(this, entityAttributeUuid) :
108                            entityAttributeLogic.getEntityAttributeByName(this, entityInstance.getEntityType(), entityAttributeName);
109
110                    if(!hasExecutionErrors()) {
111                        if(entityInstance.getEntityType().equals(entityAttribute.getLastDetail().getEntityType())) {
112                            EntityGeoPointAttribute entityGeoPointAttribute = null;
113                            var basePK = PersistenceUtils.getInstance().getBasePKFromEntityInstance(entityInstance);
114
115                            if(editMode.equals(EditMode.LOCK) || editMode.equals(EditMode.ABANDON)) {
116                                entityGeoPointAttribute = coreControl.getEntityGeoPointAttribute(entityAttribute, entityInstance);
117
118                                if(entityGeoPointAttribute != null) {
119                                    if(editMode.equals(EditMode.LOCK)) {
120                                        result.setEntityGeoPointAttribute(coreControl.getEntityGeoPointAttributeTransfer(getUserVisit(), entityGeoPointAttribute, entityInstance));
121
122                                        if(lockEntity(basePK)) {
123                                            var geoPointUtils = GeoPointUtils.getInstance();
124                                            var edit = CoreEditFactory.getEntityGeoPointAttributeEdit();
125                                            UnitOfMeasureTypeLogic.StringUnitOfMeasure stringUnitOfMeasure;
126
127                                            result.setEdit(edit);
128                                            edit.setLatitude(geoPointUtils.formatDegrees(entityGeoPointAttribute.getLatitude()));
129                                            edit.setLongitude(geoPointUtils.formatDegrees(entityGeoPointAttribute.getLongitude()));
130                                            stringUnitOfMeasure = unitOfMeasureTypeLogic.unitOfMeasureToString(this, UomConstants.UnitOfMeasureKindUseType_ELEVATION, entityGeoPointAttribute.getElevation());
131                                            edit.setElevationUnitOfMeasureTypeName(stringUnitOfMeasure.getUnitOfMeasureTypeName());
132                                            edit.setElevation(stringUnitOfMeasure.getValue());
133                                            stringUnitOfMeasure = unitOfMeasureTypeLogic.unitOfMeasureToString(this, UomConstants.UnitOfMeasureKindUseType_ALTITUDE, entityGeoPointAttribute.getAltitude());
134                                            edit.setAltitudeUnitOfMeasureTypeName(stringUnitOfMeasure.getUnitOfMeasureTypeName());
135                                            edit.setAltitude(stringUnitOfMeasure.getValue());
136                                        } else {
137                                            addExecutionError(ExecutionErrors.EntityLockFailed.name());
138                                        }
139                                    } else { // EditMode.ABANDON
140                                        unlockEntity(basePK);
141                                        basePK = null;
142                                    }
143                                } else {
144                                    addExecutionError(ExecutionErrors.UnknownEntityGeoPointAttribute.name(),
145                                            entityInstanceLogic.getEntityRefFromEntityInstance(entityInstance),
146                                            entityAttribute.getLastDetail().getEntityAttributeName());
147                                }
148                            } else if(editMode.equals(EditMode.UPDATE)) {
149                                entityGeoPointAttribute = coreControl.getEntityGeoPointAttributeForUpdate(entityAttribute, entityInstance);
150
151                                if(entityGeoPointAttribute != null) {
152                                    var elevation = unitOfMeasureTypeLogic.checkUnitOfMeasure(this, UomConstants.UnitOfMeasureKindUseType_ELEVATION,
153                                            edit.getElevation(), edit.getElevationUnitOfMeasureTypeName(),
154                                            null, ExecutionErrors.MissingRequiredElevation.name(), null, ExecutionErrors.MissingRequiredElevationUnitOfMeasureTypeName.name(),
155                                            null, ExecutionErrors.UnknownElevationUnitOfMeasureTypeName.name());
156
157                                    if(!hasExecutionErrors()) {
158                                        var altitude = unitOfMeasureTypeLogic.checkUnitOfMeasure(this, UomConstants.UnitOfMeasureKindUseType_ALTITUDE,
159                                                edit.getAltitude(), edit.getAltitudeUnitOfMeasureTypeName(),
160                                                null, ExecutionErrors.MissingRequiredAltitude.name(), null, ExecutionErrors.MissingRequiredAltitudeUnitOfMeasureTypeName.name(),
161                                                null, ExecutionErrors.UnknownAltitudeUnitOfMeasureTypeName.name());
162
163                                        if(!hasExecutionErrors()) {
164                                            if(lockEntityForUpdate(basePK)) {
165                                                try {
166                                                    var entityGeoPointAttributeValue = coreControl.getEntityGeoPointAttributeValueForUpdate(entityGeoPointAttribute);
167
168                                                    entityGeoPointAttributeValue.setLatitude(Integer.valueOf(edit.getLatitude()));
169                                                    entityGeoPointAttributeValue.setLongitude(Integer.valueOf(edit.getLongitude()));
170                                                    entityGeoPointAttributeValue.setElevation(elevation);
171                                                    entityGeoPointAttributeValue.setAltitude(altitude);
172
173                                                    coreControl.updateEntityGeoPointAttributeFromValue(entityGeoPointAttributeValue, getPartyPK());
174                                                } finally {
175                                                    unlockEntity(basePK);
176                                                    basePK = null;
177                                                }
178                                            } else {
179                                                addExecutionError(ExecutionErrors.EntityLockStale.name());
180                                            }
181                                        }
182                                    }
183                                } else {
184                                    addExecutionError(ExecutionErrors.UnknownEntityGeoPointAttribute.name(),
185                                            entityInstanceLogic.getEntityRefFromEntityInstance(entityInstance),
186                                            entityAttribute.getLastDetail().getEntityAttributeName());
187                                }
188                            }
189
190                            if(basePK != null) {
191                                result.setEntityLock(getEntityLockTransfer(basePK));
192                            }
193
194                            if(entityGeoPointAttribute != null) {
195                                result.setEntityGeoPointAttribute(coreControl.getEntityGeoPointAttributeTransfer(getUserVisit(), entityGeoPointAttribute, entityInstance));
196                            }
197                        } else {
198                            addExecutionError(ExecutionErrors.MismatchedEntityType.name());
199                        }
200                    }
201                } else {
202                    addExecutionError(ExecutionErrors.InvalidParameterCount.name());
203                }
204            }
205        } else {
206            addExecutionError(ExecutionErrors.InvalidParameterCount.name());
207        }
208
209        return result;
210    }
211    
212}