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.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.Arrays;
041import java.util.Collections;
042import java.util.List;
043import javax.enterprise.context.RequestScoped;
044
045@RequestScoped
046public class EditGeoCodeScopeCommand
047        extends BaseAbstractEditCommand<GeoCodeScopeSpec, GeoCodeScopeEdit, EditGeoCodeScopeResult, GeoCodeScope, GeoCodeScope> {
048
049    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
050    private final static List<FieldDefinition> SPEC_FIELD_DEFINITIONS;
051    private final static List<FieldDefinition> EDIT_FIELD_DEFINITIONS;
052
053    static {
054        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(Collections.unmodifiableList(Arrays.asList(
055                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
056                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), Collections.unmodifiableList(Arrays.asList(
057                    new SecurityRoleDefinition(SecurityRoleGroups.GeoCodeScope.name(), SecurityRoles.Edit.name())
058                    )))
059                )));
060
061        SPEC_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
062                new FieldDefinition("GeoCodeScopeName", FieldType.ENTITY_NAME, true, null, null)
063                ));
064
065        EDIT_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
066                new FieldDefinition("GeoCodeScopeName", FieldType.ENTITY_NAME, true, null, null),
067                new FieldDefinition("IsDefault", FieldType.BOOLEAN, true, null, null),
068                new FieldDefinition("SortOrder", FieldType.SIGNED_INTEGER, true, null, null),
069                new FieldDefinition("Description", FieldType.STRING, false, 1L, 132L)
070                ));
071    }
072
073    /** Creates a new instance of EditGeoCodeScopeCommand */
074    public EditGeoCodeScopeCommand() {
075        super(COMMAND_SECURITY_DEFINITION, SPEC_FIELD_DEFINITIONS, EDIT_FIELD_DEFINITIONS);
076    }
077
078    @Override
079    public EditGeoCodeScopeResult getResult() {
080        return GeoResultFactory.getEditGeoCodeScopeResult();
081    }
082
083    @Override
084    public GeoCodeScopeEdit getEdit() {
085        return GeoEditFactory.getGeoCodeScopeEdit();
086    }
087
088    @Override
089    public GeoCodeScope getEntity(EditGeoCodeScopeResult result) {
090        var geoControl = Session.getModelController(GeoControl.class);
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        var geoControl = Session.getModelController(GeoControl.class);
117
118        result.setGeoCodeScope(geoControl.getGeoCodeScopeTransfer(getUserVisit(), geoCodeScope));
119    }
120
121    @Override
122    public void doLock(GeoCodeScopeEdit edit, GeoCodeScope geoCodeScope) {
123        var geoControl = Session.getModelController(GeoControl.class);
124        var geoCodeScopeDescription = geoControl.getGeoCodeScopeDescription(geoCodeScope, getPreferredLanguage());
125        var geoCodeScopeDetail = geoCodeScope.getLastDetail();
126
127        edit.setGeoCodeScopeName(geoCodeScopeDetail.getGeoCodeScopeName());
128        edit.setIsDefault(geoCodeScopeDetail.getIsDefault().toString());
129        edit.setSortOrder(geoCodeScopeDetail.getSortOrder().toString());
130
131        if(geoCodeScopeDescription != null) {
132            edit.setDescription(geoCodeScopeDescription.getDescription());
133        }
134    }
135
136    @Override
137    public void canUpdate(GeoCodeScope geoCodeScope) {
138        var geoControl = Session.getModelController(GeoControl.class);
139        var geoCodeScopeName = edit.getGeoCodeScopeName();
140        var duplicateGeoCodeScope = geoControl.getGeoCodeScopeByName(geoCodeScopeName);
141
142        if(duplicateGeoCodeScope != null && geoCodeScope.equals(duplicateGeoCodeScope)) {
143            addExecutionError(ExecutionErrors.DuplicateGeoCodeScopeName.name(), geoCodeScopeName);
144        }
145    }
146
147    @Override
148    public void doUpdate(GeoCodeScope geoCodeScope) {
149        var geoControl = Session.getModelController(GeoControl.class);
150        var partyPK = getPartyPK();
151        var geoCodeScopeDetailValue = geoControl.getGeoCodeScopeDetailValueForUpdate(geoCodeScope);
152        var geoCodeScopeDescription = geoControl.getGeoCodeScopeDescriptionForUpdate(geoCodeScope, getPreferredLanguage());
153        var description = edit.getDescription();
154
155        geoCodeScopeDetailValue.setGeoCodeScopeName(edit.getGeoCodeScopeName());
156        geoCodeScopeDetailValue.setIsDefault(Boolean.valueOf(edit.getIsDefault()));
157        geoCodeScopeDetailValue.setSortOrder(Integer.valueOf(edit.getSortOrder()));
158
159        geoControl.updateGeoCodeScopeFromValue(geoCodeScopeDetailValue, partyPK);
160
161        if(geoCodeScopeDescription == null && description != null) {
162            geoControl.createGeoCodeScopeDescription(geoCodeScope, getPreferredLanguage(), description, partyPK);
163        } else {
164            if(geoCodeScopeDescription != null && description == null) {
165                geoControl.deleteGeoCodeScopeDescription(geoCodeScopeDescription, partyPK);
166            } else {
167                if(geoCodeScopeDescription != null && description != null) {
168                    var geoCodeScopeDescriptionValue = geoControl.getGeoCodeScopeDescriptionValue(geoCodeScopeDescription);
169
170                    geoCodeScopeDescriptionValue.setDescription(description);
171                    geoControl.updateGeoCodeScopeDescriptionFromValue(geoCodeScopeDescriptionValue, partyPK);
172                }
173            }
174        }
175    }
176
177}