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