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.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.core.server.entity.MimeType;
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 CreateTaxClassificationCommand
045        extends BaseSimpleCommand<CreateTaxClassificationForm> {
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.Create.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                new FieldDefinition("IsDefault", FieldType.BOOLEAN, true, null, null),
062                new FieldDefinition("SortOrder", FieldType.SIGNED_INTEGER, true, null, null),
063                new FieldDefinition("Description", FieldType.STRING, false, 1L, 132L),
064                new FieldDefinition("OverviewMimeTypeName", FieldType.MIME_TYPE, false, null, null),
065                new FieldDefinition("Overview", FieldType.STRING, false, null, null)
066                ));
067    }
068    
069    /** Creates a new instance of CreateTaxClassificationCommand */
070    public CreateTaxClassificationCommand(UserVisitPK userVisitPK, CreateTaxClassificationForm form) {
071        super(userVisitPK, form, COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
072    }
073    
074    @Override
075    protected BaseResult execute() {
076        var geoControl = Session.getModelController(GeoControl.class);
077        String countryName = form.getCountryName();
078        GeoCode geoCode = geoControl.getCountryByAlias(countryName);
079        
080        if(geoCode != null) {
081            var taxControl = Session.getModelController(TaxControl.class);
082            String taxClassificationName = form.getTaxClassificationName();
083            TaxClassification taxClassification = taxControl.getTaxClassificationByName(geoCode, taxClassificationName);
084            
085            if(taxClassification == null) {
086                String overview = form.getOverview();
087                MimeType overviewMimeType = MimeTypeLogic.getInstance().checkMimeType(this, form.getOverviewMimeTypeName(), overview, MimeTypeUsageTypes.TEXT.name(),
088                        ExecutionErrors.MissingRequiredOverviewMimeTypeName.name(), ExecutionErrors.MissingRequiredOverview.name(),
089                        ExecutionErrors.UnknownOverviewMimeTypeName.name(), ExecutionErrors.UnknownOverviewMimeTypeUsage.name());
090
091                if(!hasExecutionErrors()) {
092                    var partyPK = getPartyPK();
093                    var isDefault = Boolean.valueOf(form.getIsDefault());
094                    var sortOrder = Integer.valueOf(form.getSortOrder());
095                    var description = form.getDescription();
096
097                    taxClassification = taxControl.createTaxClassification(geoCode, taxClassificationName, isDefault, sortOrder, partyPK);
098
099                    if(description != null) {
100                        taxControl.createTaxClassificationTranslation(taxClassification, getPreferredLanguage(), description,
101                                overviewMimeType, overview, partyPK);
102                    }
103                }
104            } else {
105                addExecutionError(ExecutionErrors.DuplicateTaxClassificationName.name(), countryName, taxClassificationName);
106            }
107        } else {
108            addExecutionError(ExecutionErrors.UnknownGeoCodeName.name(), countryName);
109        }
110        
111        return null;
112    }
113    
114}