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