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.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.RequestScoped;
042
043@RequestScoped
044public class EditEntityGeoPointDefaultCommand
045        extends BaseAbstractEditCommand<EntityGeoPointDefaultSpec, EntityGeoPointDefaultEdit, EditEntityGeoPointDefaultResult, EntityGeoPointDefault, EntityAttribute> {
046
047    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
048    private final static List<FieldDefinition> SPEC_FIELD_DEFINITIONS;
049    private final static List<FieldDefinition> EDIT_FIELD_DEFINITIONS;
050
051    static {
052        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(List.of(
053                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
054                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), null)
055        ));
056
057        SPEC_FIELD_DEFINITIONS = List.of(
058                new FieldDefinition("EntityRef", FieldType.ENTITY_REF, false, null, null),
059                new FieldDefinition("Uuid", FieldType.UUID, false, null, null),
060                new FieldDefinition("ComponentVendorName", FieldType.ENTITY_NAME, false, null, null),
061                new FieldDefinition("EntityTypeName", FieldType.ENTITY_TYPE_NAME, false, null, null),
062                new FieldDefinition("EntityAttributeName", FieldType.ENTITY_NAME, 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    /** Creates a new instance of EditEntityGeoPointDefaultCommand */
076    public EditEntityGeoPointDefaultCommand() {
077        super(COMMAND_SECURITY_DEFINITION, SPEC_FIELD_DEFINITIONS, EDIT_FIELD_DEFINITIONS);
078    }
079    
080    @Override
081    public EditEntityGeoPointDefaultResult getResult() {
082        return CoreResultFactory.getEditEntityGeoPointDefaultResult();
083    }
084
085    @Override
086    public EntityGeoPointDefaultEdit getEdit() {
087        return CoreEditFactory.getEntityGeoPointDefaultEdit();
088    }
089
090    @Override
091    public EntityGeoPointDefault getEntity(EditEntityGeoPointDefaultResult result) {
092        var entityAttribute = EntityAttributeLogic.getInstance().getEntityAttributeByUniversalSpec(this, spec);
093        EntityGeoPointDefault entityGeoPointDefault = null;
094
095        if(!hasExecutionErrors()) {
096
097            if(editMode.equals(EditMode.LOCK) || editMode.equals(EditMode.ABANDON)) {
098                entityGeoPointDefault = coreControl.getEntityGeoPointDefault(entityAttribute);
099            } else { // EditMode.UPDATE
100                entityGeoPointDefault = coreControl.getEntityGeoPointDefaultForUpdate(entityAttribute);
101            }
102
103            if(entityGeoPointDefault == null) {
104                addExecutionError(ExecutionErrors.UnknownEntityGeoPointDefault.name());
105            }
106        }
107
108        return entityGeoPointDefault;
109    }
110
111    @Override
112    public EntityAttribute getLockEntity(EntityGeoPointDefault entityGeoPointDefault) {
113        return entityGeoPointDefault.getEntityAttribute();
114    }
115
116    @Override
117    public void fillInResult(EditEntityGeoPointDefaultResult result, EntityGeoPointDefault entityGeoPointDefault) {
118
119        result.setEntityGeoPointDefault(coreControl.getEntityGeoPointDefaultTransfer(getUserVisit(), entityGeoPointDefault));
120    }
121
122    @Override
123    public void doLock(EntityGeoPointDefaultEdit edit, EntityGeoPointDefault entityGeoPointDefault) {
124        var unitOfMeasureTypeLogic = UnitOfMeasureTypeLogic.getInstance();
125        var geoPointUtils = GeoPointUtils.getInstance();
126        UnitOfMeasureTypeLogic.StringUnitOfMeasure stringUnitOfMeasure;
127
128        edit.setLatitude(geoPointUtils.formatDegrees(entityGeoPointDefault.getLatitude()));
129        edit.setLongitude(geoPointUtils.formatDegrees(entityGeoPointDefault.getLongitude()));
130        stringUnitOfMeasure = unitOfMeasureTypeLogic.unitOfMeasureToString(this, UomConstants.UnitOfMeasureKindUseType_ELEVATION, entityGeoPointDefault.getElevation());
131        edit.setElevationUnitOfMeasureTypeName(stringUnitOfMeasure.getUnitOfMeasureTypeName());
132        edit.setElevation(stringUnitOfMeasure.getValue());
133        stringUnitOfMeasure = unitOfMeasureTypeLogic.unitOfMeasureToString(this, UomConstants.UnitOfMeasureKindUseType_ALTITUDE, entityGeoPointDefault.getAltitude());
134        edit.setAltitudeUnitOfMeasureTypeName(stringUnitOfMeasure.getUnitOfMeasureTypeName());
135        edit.setAltitude(stringUnitOfMeasure.getValue());
136    }
137
138    Long elevation;
139    Long altitude;
140
141    @Override
142    public void canUpdate(EntityGeoPointDefault entityGeoPointDefault) {
143        var unitOfMeasureTypeLogic = UnitOfMeasureTypeLogic.getInstance();
144
145        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        altitude = unitOfMeasureTypeLogic.checkUnitOfMeasure(this, UomConstants.UnitOfMeasureKindUseType_ALTITUDE,
151                edit.getAltitude(), edit.getAltitudeUnitOfMeasureTypeName(),
152                null, ExecutionErrors.MissingRequiredAltitude.name(), null, ExecutionErrors.MissingRequiredAltitudeUnitOfMeasureTypeName.name(),
153                null, ExecutionErrors.UnknownAltitudeUnitOfMeasureTypeName.name());
154    }
155
156    @Override
157    public void doUpdate(EntityGeoPointDefault entityGeoPointDefault) {
158        var entityGeoPointDefaultValue = coreControl.getEntityGeoPointDefaultValueForUpdate(entityGeoPointDefault);
159
160        entityGeoPointDefaultValue.setLatitude(Integer.valueOf(edit.getLatitude()));
161        entityGeoPointDefaultValue.setLongitude(Integer.valueOf(edit.getLongitude()));
162        entityGeoPointDefaultValue.setElevation(elevation);
163        entityGeoPointDefaultValue.setAltitude(altitude);
164
165        coreControl.updateEntityGeoPointDefaultFromValue(entityGeoPointDefaultValue, getPartyPK());
166    }
167    
168}