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.tax.server.command;
018
019import com.echothree.control.user.tax.common.form.GetTaxClassificationChoicesForm;
020import com.echothree.control.user.tax.common.result.GetTaxClassificationChoicesResult;
021import com.echothree.control.user.tax.common.result.TaxResultFactory;
022import com.echothree.model.control.geo.server.control.GeoControl;
023import com.echothree.model.control.party.common.PartyTypes;
024import com.echothree.model.control.security.common.SecurityRoleGroups;
025import com.echothree.model.control.security.common.SecurityRoles;
026import com.echothree.model.control.tax.server.control.TaxControl;
027import com.echothree.model.data.geo.server.entity.GeoCode;
028import com.echothree.model.data.user.common.pk.UserVisitPK;
029import com.echothree.util.common.message.ExecutionErrors;
030import com.echothree.util.common.validation.FieldDefinition;
031import com.echothree.util.common.validation.FieldType;
032import com.echothree.util.common.command.BaseResult;
033import com.echothree.util.server.control.BaseSimpleCommand;
034import com.echothree.util.server.control.CommandSecurityDefinition;
035import com.echothree.util.server.control.PartyTypeDefinition;
036import com.echothree.util.server.control.SecurityRoleDefinition;
037import com.echothree.util.server.persistence.Session;
038import java.util.Arrays;
039import java.util.Collections;
040import java.util.List;
041
042public class GetTaxClassificationChoicesCommand
043        extends BaseSimpleCommand<GetTaxClassificationChoicesForm> {
044    
045    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
046    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
047    
048    static {
049        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(Collections.unmodifiableList(Arrays.asList(
050                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), Collections.unmodifiableList(Arrays.asList(
051                    new SecurityRoleDefinition(SecurityRoleGroups.TaxClassification.name(), SecurityRoles.Choices.name())
052                    )))
053                )));
054
055        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
056                new FieldDefinition("CountryName", FieldType.ENTITY_NAME, true, null, null),
057                new FieldDefinition("TaxClassificationName", FieldType.ENTITY_NAME, true, null, null),
058                new FieldDefinition("AllowNullChoice", FieldType.BOOLEAN, true, null, null)
059                ));
060    }
061    
062    /** Creates a new instance of GetTaxClassificationChoicesCommand */
063    public GetTaxClassificationChoicesCommand(UserVisitPK userVisitPK, GetTaxClassificationChoicesForm form) {
064        super(userVisitPK, form, COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
065    }
066    
067    @Override
068    protected BaseResult execute() {
069        var geoControl = Session.getModelController(GeoControl.class);
070        GetTaxClassificationChoicesResult result = TaxResultFactory.getGetTaxClassificationChoicesResult();
071        String countryName = form.getCountryName();
072        GeoCode geoCode = geoControl.getCountryByAlias(countryName);
073        
074        if(geoCode != null) {
075            var taxControl = Session.getModelController(TaxControl.class);
076            String defaultTaxClassificationChoice = form.getDefaultTaxClassificationChoice();
077            boolean allowNullChoice = Boolean.parseBoolean(form.getAllowNullChoice());
078            
079            result.setTaxClassificationChoices(taxControl.getTaxClassificationChoices(defaultTaxClassificationChoice, getPreferredLanguage(),
080                    allowNullChoice, geoCode));
081        } else {
082            addExecutionError(ExecutionErrors.UnknownGeoCodeName.name(), countryName);
083        }
084        
085        return result;
086    }
087    
088}