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.GetTaxClassificationForm;
020import com.echothree.control.user.tax.common.result.GetTaxClassificationResult;
021import com.echothree.control.user.tax.common.result.TaxResultFactory;
022import com.echothree.model.control.core.common.EventTypes;
023import com.echothree.model.control.geo.server.control.GeoControl;
024import com.echothree.model.control.party.common.PartyTypes;
025import com.echothree.model.control.security.common.SecurityRoleGroups;
026import com.echothree.model.control.security.common.SecurityRoles;
027import com.echothree.model.control.tax.server.control.TaxControl;
028import com.echothree.model.data.geo.server.entity.GeoCode;
029import com.echothree.model.data.tax.server.entity.TaxClassification;
030import com.echothree.model.data.user.common.pk.UserVisitPK;
031import com.echothree.util.common.message.ExecutionErrors;
032import com.echothree.util.common.validation.FieldDefinition;
033import com.echothree.util.common.validation.FieldType;
034import com.echothree.util.common.command.BaseResult;
035import com.echothree.util.server.control.BaseSimpleCommand;
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;
043
044public class GetTaxClassificationCommand
045        extends BaseSimpleCommand<GetTaxClassificationForm> {
046    
047    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
048    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
049    
050    static {
051        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(Collections.unmodifiableList(Arrays.asList(
052                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
053                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), Collections.unmodifiableList(Arrays.asList(
054                    new SecurityRoleDefinition(SecurityRoleGroups.TaxClassification.name(), SecurityRoles.Review.name())
055                    )))
056                )));
057
058        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
059                new FieldDefinition("CountryName", FieldType.ENTITY_NAME, true, null, null),
060                new FieldDefinition("TaxClassificationName", FieldType.ENTITY_NAME, true, null, null)
061                ));
062    }
063    
064    /** Creates a new instance of GetTaxClassificationCommand */
065    public GetTaxClassificationCommand(UserVisitPK userVisitPK, GetTaxClassificationForm form) {
066        super(userVisitPK, form, COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, true);
067    }
068    
069    @Override
070    protected BaseResult execute() {
071        var geoControl = Session.getModelController(GeoControl.class);
072        GetTaxClassificationResult result = TaxResultFactory.getGetTaxClassificationResult();
073        String countryName = form.getCountryName();
074        GeoCode geoCode = geoControl.getCountryByAlias(countryName);
075        
076        if(geoCode != null) {
077            var taxControl = Session.getModelController(TaxControl.class);
078            String taxClassificationName = form.getTaxClassificationName();
079            TaxClassification taxClassification = taxControl.getTaxClassificationByName(geoCode, taxClassificationName);
080            
081            if(taxClassification != null) {
082                result.setTaxClassification(taxControl.getTaxClassificationTransfer(getUserVisit(), taxClassification));
083                
084                sendEvent(taxClassification.getPrimaryKey(), EventTypes.READ, null, null, getPartyPK());
085            } else {
086                addExecutionError(ExecutionErrors.UnknownTaxClassificationName.name(), countryName, taxClassificationName);
087            }
088        } else {
089            addExecutionError(ExecutionErrors.UnknownGeoCodeName.name(), countryName);
090        }
091        
092        return result;
093    }
094    
095}