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.accounting.server.command;
018
019import com.echothree.control.user.accounting.common.form.GetCurrencyForm;
020import com.echothree.control.user.accounting.common.result.AccountingResultFactory;
021import com.echothree.model.control.accounting.server.control.AccountingControl;
022import com.echothree.model.control.accounting.server.logic.CurrencyLogic;
023import com.echothree.model.control.core.common.ComponentVendors;
024import com.echothree.model.control.core.common.EntityTypes;
025import com.echothree.model.control.core.common.EventTypes;
026import com.echothree.model.control.core.server.logic.EntityInstanceLogic;
027import com.echothree.model.data.accounting.server.entity.Currency;
028import com.echothree.model.data.user.common.pk.UserVisitPK;
029import com.echothree.util.common.message.ExecutionErrors;
030import com.echothree.util.common.validation.FieldDefinition;
031import com.echothree.util.common.validation.FieldType;
032import com.echothree.util.common.command.BaseResult;
033import com.echothree.util.server.control.BaseSingleEntityCommand;
034import com.echothree.util.server.persistence.Session;
035import java.util.List;
036import javax.enterprise.context.Dependent;
037
038@Dependent
039public class GetCurrencyCommand
040        extends BaseSingleEntityCommand<Currency, GetCurrencyForm> {
041    
042    // No COMMAND_SECURITY_DEFINITION, anyone may execute this command.
043    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
044    
045    static {
046        FORM_FIELD_DEFINITIONS = List.of(
047                new FieldDefinition("CurrencyIsoName", FieldType.ENTITY_NAME, false, null, null),
048                new FieldDefinition("EntityRef", FieldType.ENTITY_REF, false, null, null),
049                new FieldDefinition("Uuid", FieldType.UUID, false, null, null)
050                );
051    }
052    
053    /** Creates a new instance of GetCurrencyCommand */
054    public GetCurrencyCommand() {
055        super(null, FORM_FIELD_DEFINITIONS, true);
056    }
057    
058    @Override
059    protected Currency getEntity() {
060        var accountingControl = Session.getModelController(AccountingControl.class);
061        Currency currency = null;
062        var currencyIsoName = form.getCurrencyIsoName();
063        var parameterCount = (currencyIsoName == null ? 0 : 1) + EntityInstanceLogic.getInstance().countPossibleEntitySpecs(form);
064
065        switch(parameterCount) {
066            case 0 -> currency = accountingControl.getDefaultCurrency();
067            case 1 -> {
068                if(currencyIsoName == null) {
069                    var entityInstance = EntityInstanceLogic.getInstance().getEntityInstance(this, form,
070                            ComponentVendors.ECHO_THREE.name(), EntityTypes.Currency.name());
071
072                    if(!hasExecutionErrors()) {
073                        currency = accountingControl.getCurrencyByEntityInstance(entityInstance);
074                    }
075                } else {
076                    currency = CurrencyLogic.getInstance().getCurrencyByName(this, currencyIsoName);
077                }
078            }
079            default -> addExecutionError(ExecutionErrors.InvalidParameterCount.name());
080        }
081        
082        if(currency != null) {
083            sendEvent(currency.getPrimaryKey(), EventTypes.READ, null, null, getPartyPK());
084        }
085
086        return currency;
087    }
088    
089    @Override
090    protected BaseResult getResult(Currency currency) {
091        var accountingControl = Session.getModelController(AccountingControl.class);
092        var result = AccountingResultFactory.getGetCurrencyResult();
093
094        if(currency != null) {
095            result.setCurrency(accountingControl.getCurrencyTransfer(getUserVisit(), currency));
096        }
097
098        return result;
099    }
100    
101}