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.sales.server.command;
018
019import com.echothree.control.user.sales.common.form.CreateSalesOrderBatchForm;
020import com.echothree.control.user.sales.common.result.CreateSalesOrderBatchResult;
021import com.echothree.control.user.sales.common.result.SalesResultFactory;
022import com.echothree.model.control.accounting.server.control.AccountingControl;
023import com.echothree.model.control.party.common.PartyTypes;
024import com.echothree.model.control.payment.server.control.PaymentMethodControl;
025import com.echothree.model.control.sales.server.logic.SalesOrderBatchLogic;
026import com.echothree.model.control.security.common.SecurityRoleGroups;
027import com.echothree.model.control.security.common.SecurityRoles;
028import com.echothree.model.data.accounting.server.entity.Currency;
029import com.echothree.model.data.batch.server.entity.Batch;
030import com.echothree.model.data.payment.server.entity.PaymentMethod;
031import com.echothree.model.data.user.common.pk.UserVisitPK;
032import com.echothree.util.common.command.BaseResult;
033import com.echothree.util.common.message.ExecutionErrors;
034import com.echothree.util.common.validation.FieldDefinition;
035import com.echothree.util.common.validation.FieldType;
036import com.echothree.util.server.control.BaseSimpleCommand;
037import com.echothree.util.server.control.CommandSecurityDefinition;
038import com.echothree.util.server.control.PartyTypeDefinition;
039import com.echothree.util.server.control.SecurityRoleDefinition;
040import com.echothree.util.server.persistence.Session;
041import java.util.Arrays;
042import java.util.Collections;
043import java.util.List;
044
045public class CreateSalesOrderBatchCommand
046        extends BaseSimpleCommand<CreateSalesOrderBatchForm> {
047    
048    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
049    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
050    
051    static {
052        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(Collections.unmodifiableList(Arrays.asList(
053                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
054                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), Collections.unmodifiableList(Arrays.asList(
055                        new SecurityRoleDefinition(SecurityRoleGroups.SalesOrderBatch.name(), SecurityRoles.Create.name())
056                        )))
057                )));
058
059        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
060                new FieldDefinition("CurrencyIsoName", FieldType.ENTITY_NAME, true, null, null),
061                new FieldDefinition("PaymentMethodName", FieldType.ENTITY_NAME, true, null, null),
062                new FieldDefinition("Count", FieldType.UNSIGNED_LONG, false, null, null),
063                new FieldDefinition("Amount:CurrencyIsoName,CurrencyIsoName", FieldType.UNSIGNED_PRICE_LINE, false, null, null)
064                ));
065    }
066    
067    /** Creates a new instance of CreateSalesOrderBatchCommand */
068    public CreateSalesOrderBatchCommand(UserVisitPK userVisitPK, CreateSalesOrderBatchForm form) {
069        super(userVisitPK, form, COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
070    }
071    
072    @Override
073    protected BaseResult execute() {
074        CreateSalesOrderBatchResult result = SalesResultFactory.getCreateSalesOrderBatchResult();
075        var accountingControl = Session.getModelController(AccountingControl.class);
076        String currencyIsoName = form.getCurrencyIsoName();
077
078        Currency currency = accountingControl.getCurrencyByIsoName(currencyIsoName);
079
080        if(currency != null) {
081            var paymentMethodControl = Session.getModelController(PaymentMethodControl.class);
082            String paymentMethodName = form.getPaymentMethodName();
083            PaymentMethod paymentMethod = paymentMethodControl.getPaymentMethodByName(paymentMethodName);
084
085            if(paymentMethod != null) {
086                String strCount = form.getCount();
087                Long count = strCount == null ? null : Long.valueOf(strCount);
088                String strAmount = form.getAmount();
089                Long amount = strAmount == null ? null : Long.valueOf(strAmount);
090
091                Batch batch = SalesOrderBatchLogic.getInstance().createBatch(this, currency, paymentMethod, count, amount, getPartyPK());
092
093                if(!hasExecutionErrors()) {
094                    result.setBatchName(batch.getLastDetail().getBatchName());
095                }
096            } else {
097                addExecutionError(ExecutionErrors.UnknownPaymentMethodName.name(), paymentMethodName);
098            }
099        } else {
100            addExecutionError(ExecutionErrors.UnknownCurrencyIsoName.name(), currencyIsoName);
101        }
102        
103        return result;
104    }
105    
106}