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 java.util.List;
040import javax.enterprise.context.Dependent;
041import javax.inject.Inject;
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    @Inject
072    GeoControl geoControl;
073
074    /** Creates a new instance of EditGeoCodeScopeCommand */
075    public EditGeoCodeScopeCommand() {
076        super(COMMAND_SECURITY_DEFINITION, SPEC_FIELD_DEFINITIONS, EDIT_FIELD_DEFINITIONS);
077    }
078
079    @Override
080    public EditGeoCodeScopeResult getResult() {
081        return GeoResultFactory.getEditGeoCodeScopeResult();
082    }
083
084    @Override
085    public GeoCodeScopeEdit getEdit() {
086        return GeoEditFactory.getGeoCodeScopeEdit();
087    }
088
089    @Override
090    public GeoCodeScope getEntity(EditGeoCodeScopeResult result) {
091        GeoCodeScope geoCodeScope;
092        var geoCodeScopeName = spec.getGeoCodeScopeName();
093
094        if(editMode.equals(EditMode.LOCK) || editMode.equals(EditMode.ABANDON)) {
095            geoCodeScope = geoControl.getGeoCodeScopeByName(geoCodeScopeName);
096        } else { // EditMode.UPDATE
097            geoCodeScope = geoControl.getGeoCodeScopeByNameForUpdate(geoCodeScopeName);
098        }
099
100        if(geoCodeScope != null) {
101            result.setGeoCodeScope(geoControl.getGeoCodeScopeTransfer(getUserVisit(), geoCodeScope));
102        } else {
103            addExecutionError(ExecutionErrors.UnknownGeoCodeScopeName.name(), geoCodeScopeName);
104        }
105
106        return geoCodeScope;
107    }
108
109    @Override
110    public GeoCodeScope getLockEntity(GeoCodeScope geoCodeScope) {
111        return geoCodeScope;
112    }
113
114    @Override
115    public void fillInResult(EditGeoCodeScopeResult result, GeoCodeScope geoCodeScope) {
116        result.setGeoCodeScope(geoControl.getGeoCodeScopeTransfer(getUserVisit(), geoCodeScope));
117    }
118
119    @Override
120    public void doLock(GeoCodeScopeEdit edit, GeoCodeScope geoCodeScope) {
121        var geoCodeScopeDescription = geoControl.getGeoCodeScopeDescription(geoCodeScope, getPreferredLanguage());
122        var geoCodeScopeDetail = geoCodeScope.getLastDetail();
123
124        edit.setGeoCodeScopeName(geoCodeScopeDetail.getGeoCodeScopeName());
125        edit.setIsDefault(geoCodeScopeDetail.getIsDefault().toString());
126        edit.setSortOrder(geoCodeScopeDetail.getSortOrder().toString());
127
128        if(geoCodeScopeDescription != null) {
129            edit.setDescription(geoCodeScopeDescription.getDescription());
130        }
131    }
132
133    @Override
134    public void canUpdate(GeoCodeScope geoCodeScope) {
135        var geoCodeScopeName = edit.getGeoCodeScopeName();
136        var duplicateGeoCodeScope = geoControl.getGeoCodeScopeByName(geoCodeScopeName);
137
138        if(duplicateGeoCodeScope != null && geoCodeScope.equals(duplicateGeoCodeScope)) {
139            addExecutionError(ExecutionErrors.DuplicateGeoCodeScopeName.name(), geoCodeScopeName);
140        }
141    }
142
143    @Override
144    public void doUpdate(GeoCodeScope geoCodeScope) {
145        var partyPK = getPartyPK();
146        var geoCodeScopeDetailValue = geoControl.getGeoCodeScopeDetailValueForUpdate(geoCodeScope);
147        var geoCodeScopeDescription = geoControl.getGeoCodeScopeDescriptionForUpdate(geoCodeScope, getPreferredLanguage());
148        var description = edit.getDescription();
149
150        geoCodeScopeDetailValue.setGeoCodeScopeName(edit.getGeoCodeScopeName());
151        geoCodeScopeDetailValue.setIsDefault(Boolean.valueOf(edit.getIsDefault()));
152        geoCodeScopeDetailValue.setSortOrder(Integer.valueOf(edit.getSortOrder()));
153
154        geoControl.updateGeoCodeScopeFromValue(geoCodeScopeDetailValue, partyPK);
155
156        if(geoCodeScopeDescription == null && description != null) {
157            geoControl.createGeoCodeScopeDescription(geoCodeScope, getPreferredLanguage(), description, partyPK);
158        } else {
159            if(geoCodeScopeDescription != null && description == null) {
160                geoControl.deleteGeoCodeScopeDescription(geoCodeScopeDescription, partyPK);
161            } else {
162                if(geoCodeScopeDescription != null && description != null) {
163                    var geoCodeScopeDescriptionValue = geoControl.getGeoCodeScopeDescriptionValue(geoCodeScopeDescription);
164
165                    geoCodeScopeDescriptionValue.setDescription(description);
166                    geoControl.updateGeoCodeScopeDescriptionFromValue(geoCodeScopeDescriptionValue, partyPK);
167                }
168            }
169        }
170    }
171
172}