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