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.GeoCodeScopeEdit;
020import com.echothree.control.user.geo.common.edit.GeoEditFactory;
021import com.echothree.control.user.geo.common.form.EditGeoCodeScopeForm;
022import com.echothree.control.user.geo.common.result.EditGeoCodeScopeResult;
023import com.echothree.control.user.geo.common.result.GeoResultFactory;
024import com.echothree.control.user.geo.common.spec.GeoCodeScopeSpec;
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.GeoCodeScope;
030import com.echothree.model.data.user.common.pk.UserVisitPK;
031import com.echothree.util.common.message.ExecutionErrors;
032import com.echothree.util.common.validation.FieldDefinition;
033import com.echothree.util.common.validation.FieldType;
034import com.echothree.util.common.command.EditMode;
035import com.echothree.util.server.control.BaseAbstractEditCommand;
036import com.echothree.util.server.control.CommandSecurityDefinition;
037import com.echothree.util.server.control.PartyTypeDefinition;
038import com.echothree.util.server.control.SecurityRoleDefinition;
039import com.echothree.util.server.persistence.Session;
040import java.util.List;
041import javax.enterprise.context.Dependent;
042
043@Dependent
044public class EditGeoCodeScopeCommand
045        extends BaseAbstractEditCommand<GeoCodeScopeSpec, GeoCodeScopeEdit, EditGeoCodeScopeResult, GeoCodeScope, GeoCodeScope> {
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(), List.of(
055                    new SecurityRoleDefinition(SecurityRoleGroups.GeoCodeScope.name(), SecurityRoles.Edit.name())
056                    ))
057                ));
058
059        SPEC_FIELD_DEFINITIONS = List.of(
060                new FieldDefinition("GeoCodeScopeName", FieldType.ENTITY_NAME, true, null, null)
061                );
062
063        EDIT_FIELD_DEFINITIONS = List.of(
064                new FieldDefinition("GeoCodeScopeName", FieldType.ENTITY_NAME, true, null, null),
065                new FieldDefinition("IsDefault", FieldType.BOOLEAN, true, null, null),
066                new FieldDefinition("SortOrder", FieldType.SIGNED_INTEGER, true, null, null),
067                new FieldDefinition("Description", FieldType.STRING, false, 1L, 132L)
068                );
069    }
070
071    /** Creates a new instance of EditGeoCodeScopeCommand */
072    public EditGeoCodeScopeCommand() {
073        super(COMMAND_SECURITY_DEFINITION, SPEC_FIELD_DEFINITIONS, EDIT_FIELD_DEFINITIONS);
074    }
075
076    @Override
077    public EditGeoCodeScopeResult getResult() {
078        return GeoResultFactory.getEditGeoCodeScopeResult();
079    }
080
081    @Override
082    public GeoCodeScopeEdit getEdit() {
083        return GeoEditFactory.getGeoCodeScopeEdit();
084    }
085
086    @Override
087    public GeoCodeScope getEntity(EditGeoCodeScopeResult result) {
088        var geoControl = Session.getModelController(GeoControl.class);
089        GeoCodeScope geoCodeScope;
090        var geoCodeScopeName = spec.getGeoCodeScopeName();
091
092        if(editMode.equals(EditMode.LOCK) || editMode.equals(EditMode.ABANDON)) {
093            geoCodeScope = geoControl.getGeoCodeScopeByName(geoCodeScopeName);
094        } else { // EditMode.UPDATE
095            geoCodeScope = geoControl.getGeoCodeScopeByNameForUpdate(geoCodeScopeName);
096        }
097
098        if(geoCodeScope != null) {
099            result.setGeoCodeScope(geoControl.getGeoCodeScopeTransfer(getUserVisit(), geoCodeScope));
100        } else {
101            addExecutionError(ExecutionErrors.UnknownGeoCodeScopeName.name(), geoCodeScopeName);
102        }
103
104        return geoCodeScope;
105    }
106
107    @Override
108    public GeoCodeScope getLockEntity(GeoCodeScope geoCodeScope) {
109        return geoCodeScope;
110    }
111
112    @Override
113    public void fillInResult(EditGeoCodeScopeResult result, GeoCodeScope geoCodeScope) {
114        var geoControl = Session.getModelController(GeoControl.class);
115
116        result.setGeoCodeScope(geoControl.getGeoCodeScopeTransfer(getUserVisit(), geoCodeScope));
117    }
118
119    @Override
120    public void doLock(GeoCodeScopeEdit edit, GeoCodeScope geoCodeScope) {
121        var geoControl = Session.getModelController(GeoControl.class);
122        var geoCodeScopeDescription = geoControl.getGeoCodeScopeDescription(geoCodeScope, getPreferredLanguage());
123        var geoCodeScopeDetail = geoCodeScope.getLastDetail();
124
125        edit.setGeoCodeScopeName(geoCodeScopeDetail.getGeoCodeScopeName());
126        edit.setIsDefault(geoCodeScopeDetail.getIsDefault().toString());
127        edit.setSortOrder(geoCodeScopeDetail.getSortOrder().toString());
128
129        if(geoCodeScopeDescription != null) {
130            edit.setDescription(geoCodeScopeDescription.getDescription());
131        }
132    }
133
134    @Override
135    public void canUpdate(GeoCodeScope geoCodeScope) {
136        var geoControl = Session.getModelController(GeoControl.class);
137        var geoCodeScopeName = edit.getGeoCodeScopeName();
138        var duplicateGeoCodeScope = geoControl.getGeoCodeScopeByName(geoCodeScopeName);
139
140        if(duplicateGeoCodeScope != null && geoCodeScope.equals(duplicateGeoCodeScope)) {
141            addExecutionError(ExecutionErrors.DuplicateGeoCodeScopeName.name(), geoCodeScopeName);
142        }
143    }
144
145    @Override
146    public void doUpdate(GeoCodeScope geoCodeScope) {
147        var geoControl = Session.getModelController(GeoControl.class);
148        var partyPK = getPartyPK();
149        var geoCodeScopeDetailValue = geoControl.getGeoCodeScopeDetailValueForUpdate(geoCodeScope);
150        var geoCodeScopeDescription = geoControl.getGeoCodeScopeDescriptionForUpdate(geoCodeScope, getPreferredLanguage());
151        var description = edit.getDescription();
152
153        geoCodeScopeDetailValue.setGeoCodeScopeName(edit.getGeoCodeScopeName());
154        geoCodeScopeDetailValue.setIsDefault(Boolean.valueOf(edit.getIsDefault()));
155        geoCodeScopeDetailValue.setSortOrder(Integer.valueOf(edit.getSortOrder()));
156
157        geoControl.updateGeoCodeScopeFromValue(geoCodeScopeDetailValue, partyPK);
158
159        if(geoCodeScopeDescription == null && description != null) {
160            geoControl.createGeoCodeScopeDescription(geoCodeScope, getPreferredLanguage(), description, partyPK);
161        } else {
162            if(geoCodeScopeDescription != null && description == null) {
163                geoControl.deleteGeoCodeScopeDescription(geoCodeScopeDescription, partyPK);
164            } else {
165                if(geoCodeScopeDescription != null && description != null) {
166                    var geoCodeScopeDescriptionValue = geoControl.getGeoCodeScopeDescriptionValue(geoCodeScopeDescription);
167
168                    geoCodeScopeDescriptionValue.setDescription(description);
169                    geoControl.updateGeoCodeScopeDescriptionFromValue(geoCodeScopeDescriptionValue, partyPK);
170                }
171            }
172        }
173    }
174
175}