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