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.form.GetGeoCodeTimeZoneForm;
020import com.echothree.control.user.geo.common.result.GeoResultFactory;
021import com.echothree.model.control.geo.server.control.GeoControl;
022import com.echothree.model.control.party.common.PartyTypes;
023import com.echothree.model.control.party.server.control.PartyControl;
024import com.echothree.model.control.security.common.SecurityRoleGroups;
025import com.echothree.model.control.security.common.SecurityRoles;
026import com.echothree.model.data.geo.server.entity.GeoCodeTimeZone;
027import com.echothree.util.common.command.BaseResult;
028import com.echothree.util.common.message.ExecutionErrors;
029import com.echothree.util.common.validation.FieldDefinition;
030import com.echothree.util.common.validation.FieldType;
031import com.echothree.util.server.control.BaseSingleEntityCommand;
032import com.echothree.util.server.control.CommandSecurityDefinition;
033import com.echothree.util.server.control.PartyTypeDefinition;
034import com.echothree.util.server.control.SecurityRoleDefinition;
035import java.util.List;
036import javax.enterprise.context.Dependent;
037import javax.inject.Inject;
038
039@Dependent
040public class GetGeoCodeTimeZoneCommand
041        extends BaseSingleEntityCommand<GeoCodeTimeZone, GetGeoCodeTimeZoneForm> {
042    
043    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
044    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
045    
046    static {
047        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(List.of(
048                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
049                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
050                        new SecurityRoleDefinition(SecurityRoleGroups.GeoCodeTimeZone.name(), SecurityRoles.Review.name())
051                ))
052        ));
053        
054        FORM_FIELD_DEFINITIONS = List.of(
055                new FieldDefinition("GeoCodeName", FieldType.ENTITY_NAME, true, null, null),
056                new FieldDefinition("JavaTimeZoneName", FieldType.TIME_ZONE_NAME, true, null, null)
057        );
058    }
059
060    @Inject
061    GeoControl geoControl;
062
063    @Inject
064    PartyControl partyControl;
065
066
067    /** Creates a new instance of GetGeoCodeTimeZoneCommand */
068    public GetGeoCodeTimeZoneCommand() {
069        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
070    }
071
072    @Override
073    protected GeoCodeTimeZone getEntity() {
074        var geoCodeName = form.getGeoCodeName();
075        var geoCode = geoControl.getGeoCodeByName(geoCodeName);
076        GeoCodeTimeZone geoCodeTimeZone = null;
077
078        if(geoCode != null) {
079            var javaTimeZoneName = form.getJavaTimeZoneName();
080            var timeZone = partyControl.getTimeZoneByJavaName(javaTimeZoneName);
081
082            if(timeZone != null) {
083                geoCodeTimeZone = geoControl.getGeoCodeTimeZoneForUpdate(geoCode, timeZone);
084
085                if(geoCodeTimeZone == null) {
086                    addExecutionError(ExecutionErrors.UnknownGeoCodeTimeZone.name(), geoCodeName, javaTimeZoneName);
087                }
088            } else {
089                addExecutionError(ExecutionErrors.UnknownJavaTimeZoneName.name(), javaTimeZoneName);
090            }
091        } else {
092            addExecutionError(ExecutionErrors.UnknownGeoCodeName.name(), geoCodeName);
093        }
094
095        return geoCodeTimeZone;
096    }
097
098    @Override
099    protected BaseResult getResult(GeoCodeTimeZone geoCodeTimeZone) {
100        var result = GeoResultFactory.getGetGeoCodeTimeZoneResult();
101
102        if(geoCodeTimeZone != null) {
103            result.setGeoCodeTimeZone(geoControl.getGeoCodeTimeZoneTransfer(getUserVisit(), geoCodeTimeZone));
104        }
105
106        return result;
107    }
108    
109}