001// --------------------------------------------------------------------------------
002// Copyright 2002-2025 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.CreateSalesOrderForm;
020import com.echothree.control.user.sales.common.result.SalesResultFactory;
021import com.echothree.model.control.party.common.PartyTypes;
022import com.echothree.model.control.sales.server.logic.SalesOrderLogic;
023import com.echothree.model.control.security.common.SecurityRoleGroups;
024import com.echothree.model.control.security.common.SecurityRoles;
025import com.echothree.model.data.user.common.pk.UserVisitPK;
026import com.echothree.util.common.command.BaseResult;
027import com.echothree.util.common.validation.FieldDefinition;
028import com.echothree.util.common.validation.FieldType;
029import com.echothree.util.server.control.BaseSimpleCommand;
030import com.echothree.util.server.control.CommandSecurityDefinition;
031import com.echothree.util.server.control.PartyTypeDefinition;
032import com.echothree.util.server.control.SecurityRoleDefinition;
033import java.util.Arrays;
034import java.util.Collections;
035import java.util.List;
036import javax.enterprise.context.RequestScoped;
037
038@RequestScoped
039public class CreateSalesOrderCommand
040        extends BaseSimpleCommand<CreateSalesOrderForm> {
041
042    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
043    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
044
045    static {
046        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(Collections.unmodifiableList(Arrays.asList(
047                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
048                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), Collections.unmodifiableList(Arrays.asList(
049                    new SecurityRoleDefinition(SecurityRoleGroups.SalesOrder.name(), SecurityRoles.Create.name())
050                    )))
051                )));
052
053        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
054                new FieldDefinition("BatchName", FieldType.ENTITY_NAME, false, null, null),
055                new FieldDefinition("SourceName", FieldType.ENTITY_NAME, false, null, null),
056                new FieldDefinition("CurrencyIsoName", FieldType.ENTITY_NAME, false, null, null),
057                new FieldDefinition("TermName", FieldType.ENTITY_NAME, false, null, null),
058                new FieldDefinition("BillToPartyName", FieldType.ENTITY_NAME, false, null, null),
059                new FieldDefinition("OrderPriorityName", FieldType.ENTITY_NAME, false, null, null),
060                new FieldDefinition("HoldUntilComplete", FieldType.BOOLEAN, false, null, null),
061                new FieldDefinition("AllowBackorders", FieldType.BOOLEAN, false, null, null),
062                new FieldDefinition("AllowSubstitutions", FieldType.BOOLEAN, false, null, null),
063                new FieldDefinition("AllowCombiningShipments", FieldType.BOOLEAN, false, null, null),
064                new FieldDefinition("Reference", FieldType.STRING, false, 1L, 40L),
065                new FieldDefinition("FreeOnBoardName", FieldType.ENTITY_NAME, false, null, null),
066                new FieldDefinition("Taxable", FieldType.BOOLEAN, false, null, null),
067                new FieldDefinition("WorkflowEntranceName", FieldType.ENTITY_NAME, false, null, null)
068                ));
069    }
070
071    /** Creates a new instance of CreateSalesOrderCommand */
072    public CreateSalesOrderCommand() {
073        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
074    }
075
076    @Override
077    protected BaseResult execute() {
078        var result = SalesResultFactory.getCreateSalesOrderResult();
079        var batchName = form.getBatchName();
080        var sourceName = form.getSourceName();
081        var billToPartyName = form.getBillToPartyName();
082        var orderPriorityName = form.getOrderPriorityName();
083        var currencyIsoName = form.getCurrencyIsoName();
084        var termName = form.getTermName();
085        var holdUntilComplete = form.getHoldUntilComplete();
086        var allowBackorders = form.getAllowBackorders();
087        var allowSubstitutions = form.getAllowSubstitutions();
088        var allowCombiningShipments = form.getAllowCombiningShipments();
089        var reference = form.getReference();
090        var freeOnBoardName = form.getFreeOnBoardName();
091        var strTaxable = form.getTaxable();
092        var workflowEntranceName = form.getWorkflowEntranceName();
093
094        var order = SalesOrderLogic.getInstance().createSalesOrder(session, this, getUserVisit(), batchName, sourceName,
095                billToPartyName, orderPriorityName, currencyIsoName, termName, holdUntilComplete, allowBackorders,
096                allowSubstitutions, allowCombiningShipments, reference, freeOnBoardName, strTaxable, workflowEntranceName,
097                getParty());
098
099        if(!hasExecutionErrors()) {
100            result.setOrderName(order.getLastDetail().getOrderName());
101            result.setEntityRef(order.getPrimaryKey().getEntityRef());
102        }
103
104        return result;
105    }
106
107}