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.geo.server.command;
018
019import com.echothree.control.user.geo.common.edit.GeoCodeAliasEdit;
020import com.echothree.control.user.geo.common.edit.GeoEditFactory;
021import com.echothree.control.user.geo.common.form.EditGeoCodeAliasForm;
022import com.echothree.control.user.geo.common.result.EditGeoCodeAliasResult;
023import com.echothree.control.user.geo.common.result.GeoResultFactory;
024import com.echothree.control.user.geo.common.spec.GeoCodeAliasSpec;
025import com.echothree.model.control.geo.server.control.GeoControl;
026import com.echothree.model.control.party.common.PartyTypes;
027import com.echothree.model.control.security.common.SecurityRoleGroups;
028import com.echothree.model.control.security.common.SecurityRoles;
029import com.echothree.model.data.geo.server.entity.GeoCode;
030import com.echothree.model.data.geo.server.entity.GeoCodeAlias;
031import com.echothree.model.data.geo.server.entity.GeoCodeAliasType;
032import com.echothree.model.data.user.common.pk.UserVisitPK;
033import com.echothree.util.common.message.ExecutionErrors;
034import com.echothree.util.common.validation.FieldDefinition;
035import com.echothree.util.common.validation.FieldType;
036import com.echothree.util.common.command.EditMode;
037import com.echothree.util.server.control.BaseAbstractEditCommand;
038import com.echothree.util.server.control.CommandSecurityDefinition;
039import com.echothree.util.server.control.PartyTypeDefinition;
040import com.echothree.util.server.control.SecurityRoleDefinition;
041import com.echothree.util.server.persistence.Session;
042import java.util.List;
043import java.util.regex.Pattern;
044import javax.enterprise.context.Dependent;
045
046@Dependent
047public class EditGeoCodeAliasCommand
048        extends BaseAbstractEditCommand<GeoCodeAliasSpec, GeoCodeAliasEdit, EditGeoCodeAliasResult, GeoCodeAlias, GeoCodeAlias> {
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(), List.of(
058                        new SecurityRoleDefinition(SecurityRoleGroups.GeoCodeAlias.name(), SecurityRoles.Edit.name())
059                        ))
060                ));
061
062        SPEC_FIELD_DEFINITIONS = List.of(
063                new FieldDefinition("GeoCodeName", FieldType.ENTITY_NAME, true, null, null),
064                new FieldDefinition("GeoCodeAliasTypeName", FieldType.ENTITY_NAME, true, null, null)
065                );
066        
067        EDIT_FIELD_DEFINITIONS = List.of(
068                new FieldDefinition("Alias", FieldType.ENTITY_NAME, true, null, null)
069                );
070    }
071    
072    /** Creates a new instance of EditGeoCodeAliasCommand */
073    public EditGeoCodeAliasCommand() {
074        super(COMMAND_SECURITY_DEFINITION, SPEC_FIELD_DEFINITIONS, EDIT_FIELD_DEFINITIONS);
075    }
076    
077    @Override
078    public EditGeoCodeAliasResult getResult() {
079        return GeoResultFactory.getEditGeoCodeAliasResult();
080    }
081
082    @Override
083    public GeoCodeAliasEdit getEdit() {
084        return GeoEditFactory.getGeoCodeAliasEdit();
085    }
086
087    GeoCode geoCode;
088    GeoCodeAliasType geoCodeAliasType;
089    
090    @Override
091    public GeoCodeAlias getEntity(EditGeoCodeAliasResult result) {
092        var geoControl = Session.getModelController(GeoControl.class);
093        GeoCodeAlias geoCodeAlias = null;
094        var geoCodeName = spec.getGeoCodeName();
095
096        geoCode = geoControl.getGeoCodeByName(geoCodeName);
097
098        if(geoCode != null) {
099            var geoCodeType = geoCode.getLastDetail().getGeoCodeType();
100            var geoCodeAliasTypeName = spec.getGeoCodeAliasTypeName();
101
102            geoCodeAliasType = geoControl.getGeoCodeAliasTypeByNameForUpdate(geoCodeType, geoCodeAliasTypeName);
103
104            if(geoCodeAliasType != null) {
105                if(editMode.equals(EditMode.LOCK) || editMode.equals(EditMode.ABANDON)) {
106                    geoCodeAlias = geoControl.getGeoCodeAlias(geoCode, geoCodeAliasType);
107                } else { // EditMode.UPDATE
108                    geoCodeAlias = geoControl.getGeoCodeAliasForUpdate(geoCode, geoCodeAliasType);
109                }
110
111                if(geoCodeAlias != null) {
112                    result.setGeoCodeAlias(geoControl.getGeoCodeAliasTransfer(getUserVisit(), geoCodeAlias));
113                } else {
114                    addExecutionError(ExecutionErrors.UnknownGeoCodeAlias.name(), geoCodeName, geoCodeAliasTypeName);
115                }
116            } else {
117                addExecutionError(ExecutionErrors.UnknownGeoCodeAliasTypeName.name(), geoCodeType.getLastDetail().getGeoCodeTypeName(), geoCodeAliasTypeName);
118            }
119        } else {
120            addExecutionError(ExecutionErrors.UnknownGeoCodeName.name(), geoCodeName);
121        }
122
123        return geoCodeAlias;
124    }
125
126    @Override
127    public GeoCodeAlias getLockEntity(GeoCodeAlias geoCodeAlias) {
128        return geoCodeAlias;
129    }
130
131    @Override
132    public void fillInResult(EditGeoCodeAliasResult result, GeoCodeAlias geoCodeAlias) {
133        var geoControl = Session.getModelController(GeoControl.class);
134
135        result.setGeoCodeAlias(geoControl.getGeoCodeAliasTransfer(getUserVisit(), geoCodeAlias));
136    }
137
138    @Override
139    public void doLock(GeoCodeAliasEdit edit, GeoCodeAlias geoCodeAlias) {
140        edit.setAlias(geoCodeAlias.getAlias());
141    }
142
143    @Override
144    public void canUpdate(GeoCodeAlias geoCodeAlias) {
145        var geoControl = Session.getModelController(GeoControl.class);
146        var geoCodeScope = geoCode.getLastDetail().getGeoCodeScope();
147        var alias = edit.getAlias();
148        var duplicateGeoCodeAlias = geoControl.getGeoCodeAliasByAliasWithinScope(geoCodeScope, geoCodeAliasType, alias);
149
150        if(duplicateGeoCodeAlias != null && !geoCodeAlias.equals(duplicateGeoCodeAlias)) {
151            addExecutionError(ExecutionErrors.DuplicateGeoCodeAlias.name(), geoCode.getLastDetail().getGeoCodeName(),
152                    geoCodeScope.getLastDetail().getGeoCodeScopeName(), geoCodeAliasType.getLastDetail().getGeoCodeAliasTypeName(), alias);
153        } else {
154            var validationPattern = geoCodeAliasType.getLastDetail().getValidationPattern();
155
156            if(validationPattern != null) {
157                var pattern = Pattern.compile(validationPattern);
158                var m = pattern.matcher(alias);
159
160                if(!m.matches()) {
161                    addExecutionError(ExecutionErrors.InvalidAlias.name(), alias);
162                }
163            }
164        }
165    }
166
167    @Override
168    public void doUpdate(GeoCodeAlias geoCodeAlias) {
169        var geoControl = Session.getModelController(GeoControl.class);
170        var geoCodeAliasValue = geoControl.getGeoCodeAliasValue(geoCodeAlias);
171
172        geoCodeAliasValue.setAlias(edit.getAlias());
173
174        geoControl.updateGeoCodeAliasFromValue(geoCodeAliasValue, getPartyPK());
175    }
176
177}