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.geo.server.command;
018
019import com.echothree.control.user.geo.common.form.GetGeoCodeCurrencyForm;
020import com.echothree.control.user.geo.common.result.GeoResultFactory;
021import com.echothree.model.control.accounting.server.control.AccountingControl;
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.data.geo.server.entity.GeoCodeCurrency;
027import com.echothree.util.common.command.BaseResult;
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.server.control.BaseSingleEntityCommand;
032import com.echothree.util.server.control.CommandSecurityDefinition;
033import com.echothree.util.server.control.PartyTypeDefinition;
034import com.echothree.util.server.control.SecurityRoleDefinition;
035import java.util.List;
036import javax.enterprise.context.Dependent;
037import javax.inject.Inject;
038
039@Dependent
040public class GetGeoCodeCurrencyCommand
041        extends BaseSingleEntityCommand<GeoCodeCurrency, GetGeoCodeCurrencyForm> {
042    
043    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
044    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
045    
046    static {
047        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(List.of(
048                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
049                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
050                        new SecurityRoleDefinition(SecurityRoleGroups.GeoCodeCurrency.name(), SecurityRoles.Review.name())
051                ))
052        ));
053        
054        FORM_FIELD_DEFINITIONS = List.of(
055                new FieldDefinition("GeoCodeName", FieldType.ENTITY_NAME, true, null, null),
056                new FieldDefinition("CurrencyIsoName", FieldType.ENTITY_NAME, true, null, null)
057        );
058    }
059
060    @Inject
061    AccountingControl accountingControl;
062
063    @Inject
064    GeoControl geoControl;
065
066    
067    /** Creates a new instance of GetGeoCodeCurrencyCommand */
068    public GetGeoCodeCurrencyCommand() {
069        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
070    }
071    
072    @Override
073    protected GeoCodeCurrency getEntity() {
074        var geoCodeName = form.getGeoCodeName();
075        var geoCode = geoControl.getGeoCodeByName(geoCodeName);
076        GeoCodeCurrency geoCodeCurrency = null;
077
078        if(geoCode != null) {
079            var currencyIsoName = form.getCurrencyIsoName();
080            var currency = accountingControl.getCurrencyByIsoName(currencyIsoName);
081
082            if(currency != null) {
083                geoCodeCurrency = geoControl.getGeoCodeCurrencyForUpdate(geoCode, currency);
084
085                if(geoCodeCurrency == null) {
086                    addExecutionError(ExecutionErrors.UnknownGeoCodeCurrency.name(), geoCodeName, currencyIsoName);
087                }
088            } else {
089                addExecutionError(ExecutionErrors.UnknownCurrencyIsoName.name(), currencyIsoName);
090            }
091        } else {
092            addExecutionError(ExecutionErrors.UnknownGeoCodeName.name(), geoCodeName);
093        }
094
095        return geoCodeCurrency;
096    }
097
098    @Override
099    protected BaseResult getResult(GeoCodeCurrency geoCodeCurrency) {
100        var result = GeoResultFactory.getGetGeoCodeCurrencyResult();
101
102        if(geoCodeCurrency != null) {
103            result.setGeoCodeCurrency(geoControl.getGeoCodeCurrencyTransfer(getUserVisit(), geoCodeCurrency));
104        }
105
106        return result;
107    }
108    
109}