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.CreateSalesOrderLineForm;
020import com.echothree.control.user.sales.common.result.SalesResultFactory;
021import com.echothree.model.control.order.server.logic.OrderLogic;
022import com.echothree.model.control.party.common.PartyTypes;
023import com.echothree.model.control.sales.server.logic.SalesOrderLineLogic;
024import com.echothree.model.control.sales.server.logic.SalesOrderLogic;
025import com.echothree.model.control.security.common.SecurityRoleGroups;
026import com.echothree.model.control.security.common.SecurityRoles;
027import com.echothree.model.data.user.common.pk.UserVisitPK;
028import com.echothree.util.common.command.BaseResult;
029import com.echothree.util.common.validation.FieldDefinition;
030import com.echothree.util.common.validation.FieldType;
031import com.echothree.util.server.control.BaseSimpleCommand;
032import com.echothree.util.server.control.CommandSecurityDefinition;
033import com.echothree.util.server.control.PartyTypeDefinition;
034import com.echothree.util.server.control.SecurityRoleDefinition;
035import com.echothree.util.server.validation.Validator;
036import java.util.Arrays;
037import java.util.Collections;
038import java.util.List;
039import javax.enterprise.context.RequestScoped;
040
041@RequestScoped
042public class CreateSalesOrderLineCommand
043        extends BaseSimpleCommand<CreateSalesOrderLineForm> {
044
045    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
046    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
047
048    static {
049        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(Collections.unmodifiableList(Arrays.asList(
050                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
051                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), Collections.unmodifiableList(Arrays.asList(
052                    new SecurityRoleDefinition(SecurityRoleGroups.SalesOrderLine.name(), SecurityRoles.Create.name())
053                    )))
054                )));
055
056        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
057                new FieldDefinition("OrderName", FieldType.ENTITY_NAME, false, null, null),
058                new FieldDefinition("OrderLineSequence", FieldType.UNSIGNED_INTEGER, false, null, null),
059                new FieldDefinition("ItemName", FieldType.ENTITY_NAME, true, null, null),
060                new FieldDefinition("InventoryConditionName", FieldType.ENTITY_NAME, false, null, null),
061                new FieldDefinition("UnitOfMeasureTypeName", FieldType.ENTITY_NAME, false, null, null),
062                new FieldDefinition("Quantity", FieldType.UNSIGNED_LONG, true, null, null),
063                new FieldDefinition("UnitAmount", FieldType.UNSIGNED_PRICE_UNIT, false, null, null),
064                new FieldDefinition("Taxable", FieldType.BOOLEAN, false, null, null),
065                new FieldDefinition("Description", FieldType.STRING, false, 1L, 132L),
066                new FieldDefinition("CancellationPolicyName", FieldType.ENTITY_NAME, false, null, null),
067                new FieldDefinition("ReturnPolicyName", FieldType.ENTITY_NAME, false, null, null),
068                new FieldDefinition("SourceName", FieldType.ENTITY_NAME, false, null, null)
069                ));
070    }
071
072    /** Creates a new instance of CreateSalesOrderLineCommand */
073    public CreateSalesOrderLineCommand() {
074        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
075    }
076
077    @Override
078    protected void setupValidator(Validator validator) {
079        var orderName = form.getOrderName();
080        var order = orderName == null ? null : SalesOrderLogic.getInstance().getOrderByName(this, orderName);
081        
082        if(order != null) {
083            validator.setCurrency(OrderLogic.getInstance().getOrderCurrency(order));
084        }
085    }
086    
087    @Override
088    protected BaseResult execute() {
089        var result = SalesResultFactory.getCreateSalesOrderLineResult();
090        var orderName = form.getOrderName();
091        var itemName = form.getItemName();
092        var inventoryConditionName = form.getInventoryConditionName();
093        var cancellationPolicyName = form.getCancellationPolicyName();
094        var returnPolicyName = form.getReturnPolicyName();
095        var unitOfMeasureTypeName = form.getUnitOfMeasureTypeName();
096        var sourceName = form.getSourceName();
097        var orderLineSequence = form.getOrderLineSequence();
098        var quantity = form.getQuantity();
099        var unitAmount = form.getUnitAmount();
100        var description = form.getDescription();
101        var taxable = form.getTaxable();
102
103        var orderLine = SalesOrderLineLogic.getInstance().createOrderLine(session, this, getUserVisit(), orderName,
104                itemName, inventoryConditionName, cancellationPolicyName, returnPolicyName, unitOfMeasureTypeName,
105                sourceName, orderLineSequence, quantity, unitAmount, description, taxable, getParty());
106
107        if(!hasExecutionErrors()) {
108            var orderLineDetail = orderLine.getLastDetail();
109
110            result.setOrderName(orderLineDetail.getOrder().getLastDetail().getOrderName());
111            result.setOrderLineSequence(orderLineDetail.getOrderLineSequence().toString());
112            result.setEntityRef(orderLine.getPrimaryKey().getEntityRef());
113        }
114
115        return result;
116    }
117
118}