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.control.user.tax.common.result.TaxResultFactory;
021import com.echothree.model.control.core.common.MimeTypeUsageTypes;
022import com.echothree.model.control.core.server.logic.MimeTypeLogic;
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.tax.server.entity.TaxClassification;
029import com.echothree.model.data.user.common.pk.UserVisitPK;
030import com.echothree.util.common.command.BaseResult;
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.server.control.BaseSimpleCommand;
035import com.echothree.util.server.control.CommandSecurityDefinition;
036import com.echothree.util.server.control.PartyTypeDefinition;
037import com.echothree.util.server.control.SecurityRoleDefinition;
038import java.util.List;
039import javax.enterprise.context.Dependent;
040import javax.inject.Inject;
041
042@Dependent
043public class CreateTaxClassificationCommand
044        extends BaseSimpleCommand<CreateTaxClassificationForm> {
045    
046    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
047    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
048    
049    static {
050        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(List.of(
051                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
052                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
053                        new SecurityRoleDefinition(SecurityRoleGroups.TaxClassification.name(), SecurityRoles.Create.name())
054                ))
055        ));
056
057        FORM_FIELD_DEFINITIONS = List.of(
058                new FieldDefinition("CountryName", FieldType.ENTITY_NAME, true, null, null),
059                new FieldDefinition("TaxClassificationName", FieldType.ENTITY_NAME, true, null, null),
060                new FieldDefinition("IsDefault", FieldType.BOOLEAN, true, null, null),
061                new FieldDefinition("SortOrder", FieldType.SIGNED_INTEGER, true, null, null),
062                new FieldDefinition("Description", FieldType.STRING, false, 1L, 132L),
063                new FieldDefinition("OverviewMimeTypeName", FieldType.MIME_TYPE, false, null, null),
064                new FieldDefinition("Overview", FieldType.STRING, false, null, null)
065        );
066    }
067
068    @Inject
069    GeoControl geoControl;
070
071    @Inject
072    TaxControl taxControl;
073
074    @Inject
075    MimeTypeLogic mimeTypeLogic;
076
077    
078    /** Creates a new instance of CreateTaxClassificationCommand */
079    public CreateTaxClassificationCommand() {
080        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
081    }
082    
083    @Override
084    protected BaseResult execute() {
085        var result = TaxResultFactory.getCreateTaxClassificationResult();
086        TaxClassification taxClassification = null;
087        var countryName = form.getCountryName();
088        var geoCode = geoControl.getCountryByAlias(countryName);
089        
090        if(geoCode != null) {
091            var taxClassificationName = form.getTaxClassificationName();
092
093            taxClassification = taxControl.getTaxClassificationByName(geoCode, taxClassificationName);
094            
095            if(taxClassification == null) {
096                var overview = form.getOverview();
097                var overviewMimeType = mimeTypeLogic.checkMimeType(this, form.getOverviewMimeTypeName(), overview, MimeTypeUsageTypes.TEXT.name(),
098                        ExecutionErrors.MissingRequiredOverviewMimeTypeName.name(), ExecutionErrors.MissingRequiredOverview.name(),
099                        ExecutionErrors.UnknownOverviewMimeTypeName.name(), ExecutionErrors.UnknownOverviewMimeTypeUsage.name());
100
101                if(!hasExecutionErrors()) {
102                    var partyPK = getPartyPK();
103                    var isDefault = Boolean.valueOf(form.getIsDefault());
104                    var sortOrder = Integer.valueOf(form.getSortOrder());
105                    var description = form.getDescription();
106
107                    taxClassification = taxControl.createTaxClassification(geoCode, taxClassificationName, isDefault, sortOrder, partyPK);
108
109                    if(description != null) {
110                        taxControl.createTaxClassificationTranslation(taxClassification, getPreferredLanguage(), description,
111                                overviewMimeType, overview, partyPK);
112                    }
113                }
114            } else {
115                addExecutionError(ExecutionErrors.DuplicateTaxClassificationName.name(), countryName, taxClassificationName);
116            }
117        } else {
118            addExecutionError(ExecutionErrors.UnknownGeoCodeName.name(), countryName);
119        }
120        
121        if(taxClassification != null) {
122            result.setEntityRef(taxClassification.getPrimaryKey().getEntityRef());
123            result.setCountryName(form.getCountryName());
124            result.setTaxClassificationName(taxClassification.getLastDetail().getTaxClassificationName());
125        }
126
127        return result;
128    }
129    
130}