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.CreateTaxClassificationForm;
020import com.echothree.model.control.core.common.MimeTypeUsageTypes;
021import com.echothree.model.control.core.server.logic.MimeTypeLogic;
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.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.List;
038import javax.enterprise.context.Dependent;
039
040@Dependent
041public class CreateTaxClassificationCommand
042        extends BaseSimpleCommand<CreateTaxClassificationForm> {
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(List.of(
049                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
050                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
051                    new SecurityRoleDefinition(SecurityRoleGroups.TaxClassification.name(), SecurityRoles.Create.name())
052                    ))
053                ));
054
055        FORM_FIELD_DEFINITIONS = List.of(
056                new FieldDefinition("CountryName", FieldType.ENTITY_NAME, true, null, null),
057                new FieldDefinition("TaxClassificationName", FieldType.ENTITY_NAME, true, null, null),
058                new FieldDefinition("IsDefault", FieldType.BOOLEAN, true, null, null),
059                new FieldDefinition("SortOrder", FieldType.SIGNED_INTEGER, true, null, null),
060                new FieldDefinition("Description", FieldType.STRING, false, 1L, 132L),
061                new FieldDefinition("OverviewMimeTypeName", FieldType.MIME_TYPE, false, null, null),
062                new FieldDefinition("Overview", FieldType.STRING, false, null, null)
063                );
064    }
065    
066    /** Creates a new instance of CreateTaxClassificationCommand */
067    public CreateTaxClassificationCommand() {
068        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
069    }
070    
071    @Override
072    protected BaseResult execute() {
073        var geoControl = Session.getModelController(GeoControl.class);
074        var countryName = form.getCountryName();
075        var geoCode = geoControl.getCountryByAlias(countryName);
076        
077        if(geoCode != null) {
078            var taxControl = Session.getModelController(TaxControl.class);
079            var taxClassificationName = form.getTaxClassificationName();
080            var taxClassification = taxControl.getTaxClassificationByName(geoCode, taxClassificationName);
081            
082            if(taxClassification == null) {
083                var overview = form.getOverview();
084                var overviewMimeType = MimeTypeLogic.getInstance().checkMimeType(this, form.getOverviewMimeTypeName(), overview, MimeTypeUsageTypes.TEXT.name(),
085                        ExecutionErrors.MissingRequiredOverviewMimeTypeName.name(), ExecutionErrors.MissingRequiredOverview.name(),
086                        ExecutionErrors.UnknownOverviewMimeTypeName.name(), ExecutionErrors.UnknownOverviewMimeTypeUsage.name());
087
088                if(!hasExecutionErrors()) {
089                    var partyPK = getPartyPK();
090                    var isDefault = Boolean.valueOf(form.getIsDefault());
091                    var sortOrder = Integer.valueOf(form.getSortOrder());
092                    var description = form.getDescription();
093
094                    taxClassification = taxControl.createTaxClassification(geoCode, taxClassificationName, isDefault, sortOrder, partyPK);
095
096                    if(description != null) {
097                        taxControl.createTaxClassificationTranslation(taxClassification, getPreferredLanguage(), description,
098                                overviewMimeType, overview, partyPK);
099                    }
100                }
101            } else {
102                addExecutionError(ExecutionErrors.DuplicateTaxClassificationName.name(), countryName, taxClassificationName);
103            }
104        } else {
105            addExecutionError(ExecutionErrors.UnknownGeoCodeName.name(), countryName);
106        }
107        
108        return null;
109    }
110    
111}