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.form.GetGeoCodeDateTimeFormatsForm;
020import com.echothree.control.user.geo.common.result.GeoResultFactory;
021import com.echothree.control.user.geo.common.result.GetGeoCodeDateTimeFormatsResult;
022import com.echothree.model.control.geo.server.control.GeoControl;
023import com.echothree.model.control.party.common.PartyTypes;
024import com.echothree.model.control.party.server.control.PartyControl;
025import com.echothree.model.control.security.common.SecurityRoleGroups;
026import com.echothree.model.control.security.common.SecurityRoles;
027import com.echothree.model.data.geo.server.entity.GeoCode;
028import com.echothree.model.data.party.server.entity.DateTimeFormat;
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.server.control.BaseSimpleCommand;
035import com.echothree.util.server.control.CommandSecurityDefinition;
036import com.echothree.util.server.control.PartyTypeDefinition;
037import com.echothree.util.server.control.SecurityRoleDefinition;
038import com.echothree.util.server.persistence.Session;
039import java.util.Arrays;
040import java.util.Collections;
041import java.util.List;
042
043public class GetGeoCodeDateTimeFormatsCommand
044        extends BaseSimpleCommand<GetGeoCodeDateTimeFormatsForm> {
045    
046    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
047    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
048    
049    static {
050        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(Collections.unmodifiableList(Arrays.asList(
051                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
052                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), Collections.unmodifiableList(Arrays.asList(
053                        new SecurityRoleDefinition(SecurityRoleGroups.GeoCodeDateTimeFormat.name(), SecurityRoles.List.name())
054                        )))
055                )));
056        
057        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
058                new FieldDefinition("GeoCodeName", FieldType.ENTITY_NAME, false, null, null),
059                new FieldDefinition("DateTimeFormatName", FieldType.ENTITY_NAME, false, null, null)
060                ));
061    }
062    
063    /** Creates a new instance of GetGeoCodeDateTimeFormatsCommand */
064    public GetGeoCodeDateTimeFormatsCommand(UserVisitPK userVisitPK, GetGeoCodeDateTimeFormatsForm form) {
065        super(userVisitPK, form, COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, true);
066    }
067    
068    @Override
069    protected BaseResult execute() {
070        var geoControl = Session.getModelController(GeoControl.class);
071        GetGeoCodeDateTimeFormatsResult result = GeoResultFactory.getGetGeoCodeDateTimeFormatsResult();
072        String geoCodeName = form.getGeoCodeName();
073        String dateTimeFormatName = form.getDateTimeFormatName();
074        var parameterCount = (geoCodeName != null? 1: 0) + (dateTimeFormatName != null? 1: 0);
075        
076        if(parameterCount == 1) {
077            if(geoCodeName != null) {
078                GeoCode geoCode = geoControl.getGeoCodeByName(geoCodeName);
079                
080                if(geoCode != null) {
081                    result.setGeoCode(geoControl.getGeoCodeTransfer(getUserVisit(), geoCode));
082                    result.setGeoCodeDateTimeFormats(geoControl.getGeoCodeDateTimeFormatTransfersByGeoCode(getUserVisit(), geoCode));
083                } else {
084                    addExecutionError(ExecutionErrors.UnknownGeoCodeName.name(), geoCodeName);
085                }
086            } else if(dateTimeFormatName != null) {
087                var partyControl = Session.getModelController(PartyControl.class);
088                DateTimeFormat dateTimeFormat = partyControl.getDateTimeFormatByName(dateTimeFormatName);
089                
090                if(dateTimeFormat != null) {
091                    result.setDateTimeFormat(partyControl.getDateTimeFormatTransfer(getUserVisit(), dateTimeFormat));
092                    result.setGeoCodeDateTimeFormats(geoControl.getGeoCodeDateTimeFormatTransfersByDateTimeFormat(getUserVisit(), dateTimeFormat));
093                } else {
094                    addExecutionError(ExecutionErrors.UnknownDateTimeFormatName.name(), dateTimeFormatName);
095                }
096            }
097        } else {
098            addExecutionError(ExecutionErrors.InvalidParameterCount.name());
099        }
100        
101        return result;
102    }
103    
104}