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.tax.server.command;
018
019import com.echothree.control.user.tax.common.form.GetTaxClassificationChoicesForm;
020import com.echothree.control.user.tax.common.result.TaxResultFactory;
021import com.echothree.model.control.geo.server.control.GeoControl;
022import com.echothree.model.control.party.common.PartyTypes;
023import com.echothree.model.control.security.common.SecurityRoleGroups;
024import com.echothree.model.control.security.common.SecurityRoles;
025import com.echothree.model.control.tax.server.control.TaxControl;
026import com.echothree.model.data.user.common.pk.UserVisitPK;
027import com.echothree.util.common.message.ExecutionErrors;
028import com.echothree.util.common.validation.FieldDefinition;
029import com.echothree.util.common.validation.FieldType;
030import com.echothree.util.common.command.BaseResult;
031import com.echothree.util.server.control.BaseSimpleCommand;
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 GetTaxClassificationChoicesCommand
041        extends BaseSimpleCommand<GetTaxClassificationChoicesForm> {
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.EMPLOYEE.name(), List.of(
049                        new SecurityRoleDefinition(SecurityRoleGroups.TaxClassification.name(), SecurityRoles.Choices.name())
050                ))
051        ));
052
053        FORM_FIELD_DEFINITIONS = List.of(
054                new FieldDefinition("CountryName", FieldType.ENTITY_NAME, true, null, null),
055                new FieldDefinition("TaxClassificationName", FieldType.ENTITY_NAME, true, null, null),
056                new FieldDefinition("AllowNullChoice", FieldType.BOOLEAN, true, null, null)
057        );
058    }
059
060    @Inject
061    GeoControl geoControl;
062
063    @Inject
064    TaxControl taxControl;
065
066    
067    /** Creates a new instance of GetTaxClassificationChoicesCommand */
068    public GetTaxClassificationChoicesCommand() {
069        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
070    }
071    
072    @Override
073    protected BaseResult execute() {
074        var result = TaxResultFactory.getGetTaxClassificationChoicesResult();
075        var countryName = form.getCountryName();
076        var geoCode = geoControl.getCountryByAlias(countryName);
077        
078        if(geoCode != null) {
079            var defaultTaxClassificationChoice = form.getDefaultTaxClassificationChoice();
080            var allowNullChoice = Boolean.parseBoolean(form.getAllowNullChoice());
081            
082            result.setTaxClassificationChoices(taxControl.getTaxClassificationChoices(defaultTaxClassificationChoice, getPreferredLanguage(),
083                    allowNullChoice, geoCode));
084        } else {
085            addExecutionError(ExecutionErrors.UnknownGeoCodeName.name(), countryName);
086        }
087        
088        return result;
089    }
090    
091}