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.SetDefaultTaxClassificationForm;
020import com.echothree.model.control.geo.server.control.GeoControl;
021import com.echothree.model.control.party.common.PartyTypes;
022import com.echothree.model.control.security.common.SecurityRoleGroups;
023import com.echothree.model.control.security.common.SecurityRoles;
024import com.echothree.model.control.tax.server.control.TaxControl;
025import com.echothree.model.data.geo.server.entity.GeoCode;
026import com.echothree.model.data.tax.server.value.TaxClassificationDetailValue;
027import com.echothree.model.data.user.common.pk.UserVisitPK;
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.common.command.BaseResult;
032import com.echothree.util.server.control.BaseSimpleCommand;
033import com.echothree.util.server.control.CommandSecurityDefinition;
034import com.echothree.util.server.control.PartyTypeDefinition;
035import com.echothree.util.server.control.SecurityRoleDefinition;
036import com.echothree.util.server.persistence.Session;
037import java.util.Arrays;
038import java.util.Collections;
039import java.util.List;
040
041public class SetDefaultTaxClassificationCommand
042        extends BaseSimpleCommand<SetDefaultTaxClassificationForm> {
043    
044    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
045    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
046    
047    static {
048        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(Collections.unmodifiableList(Arrays.asList(
049                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), Collections.unmodifiableList(Arrays.asList(
050                    new SecurityRoleDefinition(SecurityRoleGroups.TaxClassification.name(), SecurityRoles.Edit.name())
051                    )))
052                )));
053
054        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
055                new FieldDefinition("CountryName", FieldType.ENTITY_NAME, true, null, null),
056                new FieldDefinition("TaxClassificationName", FieldType.ENTITY_NAME, true, null, null)
057                ));
058    }
059    
060    /** Creates a new instance of SetDefaultTaxClassificationCommand */
061    public SetDefaultTaxClassificationCommand(UserVisitPK userVisitPK, SetDefaultTaxClassificationForm form) {
062        super(userVisitPK, form, COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
063    }
064    
065    @Override
066    protected BaseResult execute() {
067        var geoControl = Session.getModelController(GeoControl.class);
068        String countryName = form.getCountryName();
069        GeoCode geoCode = geoControl.getCountryByAlias(countryName);
070        
071        if(geoCode != null) {
072            var taxControl = Session.getModelController(TaxControl.class);
073            String taxClassificationName = form.getTaxClassificationName();
074            TaxClassificationDetailValue taxClassificationDetailValue = taxControl.getTaxClassificationDetailValueByNameForUpdate(geoCode,
075                    taxClassificationName);
076            
077            if(taxClassificationDetailValue != null) {
078                taxClassificationDetailValue.setIsDefault(Boolean.TRUE);
079                taxControl.updateTaxClassificationFromValue(taxClassificationDetailValue, getPartyPK());
080            } else {
081                addExecutionError(ExecutionErrors.UnknownTaxClassificationName.name(), countryName, taxClassificationName);
082            }
083        } else {
084            addExecutionError(ExecutionErrors.UnknownCountryName.name(), countryName);
085        }
086        
087        return null;
088    }
089    
090}