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