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.GetTaxDescriptionsForm;
020import com.echothree.control.user.tax.common.result.GetTaxDescriptionsResult;
021import com.echothree.control.user.tax.common.result.TaxResultFactory;
022import com.echothree.model.control.tax.server.control.TaxControl;
023import com.echothree.model.data.tax.server.entity.Tax;
024import com.echothree.model.data.user.common.pk.UserVisitPK;
025import com.echothree.util.common.message.ExecutionErrors;
026import com.echothree.util.common.validation.FieldDefinition;
027import com.echothree.util.common.validation.FieldType;
028import com.echothree.util.common.command.BaseResult;
029import com.echothree.util.server.control.BaseSimpleCommand;
030import com.echothree.util.server.persistence.Session;
031import java.util.Arrays;
032import java.util.Collections;
033import java.util.List;
034
035public class GetTaxDescriptionsCommand
036        extends BaseSimpleCommand<GetTaxDescriptionsForm> {
037    
038    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
039    
040    static {
041        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
042                new FieldDefinition("TaxName", FieldType.ENTITY_NAME, true, null, null)
043                ));
044    }
045    
046    /** Creates a new instance of GetTaxDescriptionsCommand */
047    public GetTaxDescriptionsCommand(UserVisitPK userVisitPK, GetTaxDescriptionsForm form) {
048        super(userVisitPK, form, null, FORM_FIELD_DEFINITIONS, true);
049    }
050    
051    @Override
052    protected BaseResult execute() {
053        var taxControl = Session.getModelController(TaxControl.class);
054        GetTaxDescriptionsResult result = TaxResultFactory.getGetTaxDescriptionsResult();
055        String taxName = form.getTaxName();
056        Tax tax = taxControl.getTaxByName(taxName);
057        
058        if(tax != null) {
059            result.setTax(taxControl.getTaxTransfer(getUserVisit(), tax));
060            result.setTaxDescriptions(taxControl.getTaxDescriptionTransfersByTax(getUserVisit(), tax));
061        } else {
062            addExecutionError(ExecutionErrors.UnknownTaxName.name(), taxName);
063        }
064        
065        return result;
066    }
067    
068}