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.GeoCodeTimeZoneEdit;
020import com.echothree.control.user.geo.common.edit.GeoEditFactory;
021import com.echothree.control.user.geo.common.form.EditGeoCodeTimeZoneForm;
022import com.echothree.control.user.geo.common.result.GeoResultFactory;
023import com.echothree.control.user.geo.common.spec.GeoCodeTimeZoneSpec;
024import com.echothree.model.control.geo.server.control.GeoControl;
025import com.echothree.model.control.party.common.PartyTypes;
026import com.echothree.model.control.party.server.control.PartyControl;
027import com.echothree.model.control.security.common.SecurityRoleGroups;
028import com.echothree.model.control.security.common.SecurityRoles;
029import com.echothree.model.data.user.common.pk.UserVisitPK;
030import com.echothree.util.common.message.ExecutionErrors;
031import com.echothree.util.common.validation.FieldDefinition;
032import com.echothree.util.common.validation.FieldType;
033import com.echothree.util.common.command.BaseResult;
034import com.echothree.util.common.command.EditMode;
035import com.echothree.util.server.control.BaseEditCommand;
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 EditGeoCodeTimeZoneCommand
047        extends BaseEditCommand<GeoCodeTimeZoneSpec, GeoCodeTimeZoneEdit> {
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.GeoCodeTimeZone.name(), SecurityRoles.Edit.name())
058                        )))
059                )));
060        
061        SPEC_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
062                new FieldDefinition("GeoCodeName", FieldType.ENTITY_NAME, true, null, null),
063                new FieldDefinition("JavaTimeZoneName", FieldType.TIME_ZONE_NAME, true, null, null)
064                ));
065        
066        EDIT_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
067                new FieldDefinition("IsDefault", FieldType.BOOLEAN, true, null, null),
068                new FieldDefinition("SortOrder", FieldType.SIGNED_INTEGER, true, null, null)
069                ));
070    }
071    
072    /** Creates a new instance of EditGeoCodeTimeZoneCommand */
073    public EditGeoCodeTimeZoneCommand() {
074        super(COMMAND_SECURITY_DEFINITION, SPEC_FIELD_DEFINITIONS, EDIT_FIELD_DEFINITIONS);
075    }
076    
077    @Override
078    protected BaseResult execute() {
079        var geoControl = Session.getModelController(GeoControl.class);
080        var result = GeoResultFactory.getEditGeoCodeTimeZoneResult();
081        var geoCodeName = spec.getGeoCodeName();
082        var geoCode = geoControl.getGeoCodeByName(geoCodeName);
083        
084        if(geoCode != null) {
085            var partyControl = Session.getModelController(PartyControl.class);
086            var javaTimeZoneName = spec.getJavaTimeZoneName();
087            var timeZone = partyControl.getTimeZoneByJavaName(javaTimeZoneName);
088            
089            if(timeZone != null) {
090                if(editMode.equals(EditMode.LOCK)) {
091                    var geoCodeTimeZone = geoControl.getGeoCodeTimeZone(geoCode, timeZone);
092                    
093                    if(geoCodeTimeZone != null) {
094                        result.setGeoCodeTimeZone(geoControl.getGeoCodeTimeZoneTransfer(getUserVisit(), geoCodeTimeZone));
095                        
096                        if(lockEntity(geoCode)) {
097                            var edit = GeoEditFactory.getGeoCodeTimeZoneEdit();
098                            
099                            result.setEdit(edit);
100                            edit.setIsDefault(geoCodeTimeZone.getIsDefault().toString());
101                            edit.setSortOrder(geoCodeTimeZone.getSortOrder().toString());
102                            
103                        } else {
104                            addExecutionError(ExecutionErrors.EntityLockFailed.name());
105                        }
106                        
107                        result.setEntityLock(getEntityLockTransfer(geoCode));
108                    } else {
109                        addExecutionError(ExecutionErrors.UnknownGeoCodeTimeZone.name(), geoCodeName, javaTimeZoneName);
110                    }
111                } else if(editMode.equals(EditMode.UPDATE)) {
112                    var geoCodeTimeZone = geoControl.getGeoCodeTimeZoneForUpdate(geoCode, timeZone);
113                    
114                    if(geoCodeTimeZone != null) {
115                        var geoCodeTimeZoneValue = geoControl.getGeoCodeTimeZoneValue(geoCodeTimeZone);
116                        
117                        if(lockEntityForUpdate(geoCode)) {
118                            try {
119                                geoCodeTimeZoneValue.setIsDefault(Boolean.valueOf(edit.getIsDefault()));
120                                geoCodeTimeZoneValue.setSortOrder(Integer.valueOf(edit.getSortOrder()));
121                                
122                                geoControl.updateGeoCodeTimeZoneFromValue(geoCodeTimeZoneValue, getPartyPK());
123                            } finally {
124                                unlockEntity(geoCode);
125                            }
126                        } else {
127                            addExecutionError(ExecutionErrors.EntityLockStale.name());
128                        }
129                    } else {
130                        addExecutionError(ExecutionErrors.UnknownGeoCodeTimeZone.name(), geoCodeName, javaTimeZoneName);
131                    }
132                    
133                    if(hasExecutionErrors()) {
134                        result.setGeoCodeTimeZone(geoControl.getGeoCodeTimeZoneTransfer(getUserVisit(), geoCodeTimeZone));
135                        result.setEntityLock(getEntityLockTransfer(geoCode));
136                    }
137                }
138            } else {
139                addExecutionError(ExecutionErrors.UnknownJavaTimeZoneName.name(), javaTimeZoneName);
140            }
141        } else {
142            addExecutionError(ExecutionErrors.UnknownGeoCodeName.name(), geoCodeName);
143        }
144        
145        return result;
146    }
147    
148}