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.accounting.server.command;
018
019import com.echothree.control.user.accounting.common.form.GetCurrenciesForm;
020import com.echothree.control.user.accounting.common.result.AccountingResultFactory;
021import com.echothree.model.control.accounting.server.control.AccountingControl;
022import com.echothree.model.data.accounting.server.entity.Currency;
023import com.echothree.model.data.user.common.pk.UserVisitPK;
024import com.echothree.util.common.command.BaseResult;
025import com.echothree.util.common.validation.FieldDefinition;
026import com.echothree.util.server.control.BasePaginatedMultipleEntitiesCommand;
027import com.echothree.util.server.persistence.Session;
028import java.util.Collection;
029import java.util.List;
030
031public class GetCurrenciesCommand
032        extends BasePaginatedMultipleEntitiesCommand<Currency, GetCurrenciesForm> {
033    
034    // No COMMAND_SECURITY_DEFINITION, anyone may execute this command.
035    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
036
037    static {
038        FORM_FIELD_DEFINITIONS = List.of();
039    }
040    
041    /** Creates a new instance of GetCurrenciesCommand */
042    public GetCurrenciesCommand(UserVisitPK userVisitPK, GetCurrenciesForm form) {
043        super(userVisitPK, form, null, FORM_FIELD_DEFINITIONS, true);
044    }
045
046    @Override
047    protected void handleForm() {
048        // No form fields.
049    }
050
051    @Override
052    protected Long getTotalEntities() {
053        var accountingControl = Session.getModelController(AccountingControl.class);
054
055        return accountingControl.countCurrencies();
056    }
057
058    @Override
059    protected Collection<Currency> getEntities() {
060        var accountingControl = Session.getModelController(AccountingControl.class);
061        
062        return accountingControl.getCurrencies();
063    }
064    
065    @Override
066    protected BaseResult getResult(Collection<Currency> entities) {
067        var result = AccountingResultFactory.getGetCurrenciesResult();
068        var accountingControl = Session.getModelController(AccountingControl.class);
069        
070        result.setCurrencies(accountingControl.getCurrencyTransfers(getUserVisit(), entities));
071        
072        return result;
073    }
074    
075}