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.purchase.server.command;
018
019import com.echothree.control.user.purchase.common.form.CreatePurchaseOrderForm;
020import com.echothree.control.user.purchase.common.result.PurchaseResultFactory;
021import com.echothree.model.control.party.common.PartyTypes;
022import com.echothree.model.control.purchase.server.logic.PurchaseOrderLogic;
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 CreatePurchaseOrderCommand
039        extends BaseSimpleCommand<CreatePurchaseOrderForm> {
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.PurchaseOrder.name(), SecurityRoles.Create.name())
049                ))
050        ));
051
052        FORM_FIELD_DEFINITIONS = List.of(
053                new FieldDefinition("VendorName", FieldType.ENTITY_NAME, true, null, null),
054                new FieldDefinition("TermName", FieldType.ENTITY_NAME, false, null, null),
055                new FieldDefinition("HoldUntilComplete", FieldType.BOOLEAN, false, null, null),
056                new FieldDefinition("AllowBackorders", FieldType.BOOLEAN, false, null, null),
057                new FieldDefinition("AllowSubstitutions", FieldType.BOOLEAN, false, null, null),
058                new FieldDefinition("AllowCombiningShipments", FieldType.BOOLEAN, false, null, null),
059                new FieldDefinition("Reference", FieldType.STRING, false, 1L, 40L),
060                new FieldDefinition("FreeOnBoardName", FieldType.ENTITY_NAME, false, null, null),
061                new FieldDefinition("WorkflowEntranceName", FieldType.ENTITY_NAME, false, null, null)
062        );
063    }
064
065    @Inject
066    PurchaseOrderLogic purchaseOrderLogic;
067
068    /** Creates a new instance of CreatePurchaseOrderCommand */
069    public CreatePurchaseOrderCommand() {
070        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
071    }
072
073    @Override
074    protected BaseResult execute() {
075        var result = PurchaseResultFactory.getCreatePurchaseOrderResult();
076        var vendorName = form.getVendorName();
077        var termName = form.getTermName();
078        var holdUntilComplete = form.getHoldUntilComplete();
079        var allowBackorders = form.getAllowBackorders();
080        var allowSubstitutions = form.getAllowSubstitutions();
081        var allowCombiningShipments = form.getAllowCombiningShipments();
082        var reference = form.getReference();
083        var freeOnBoardName = form.getFreeOnBoardName();
084        var workflowEntranceName = form.getWorkflowEntranceName();
085
086        var order = purchaseOrderLogic.createPurchaseOrder(session, this, getUserVisit(), vendorName,
087                termName, holdUntilComplete, allowBackorders, allowSubstitutions, allowCombiningShipments, reference,
088                freeOnBoardName, workflowEntranceName, getParty());
089
090        if(!hasExecutionErrors()) {
091            result.setOrderName(order.getLastDetail().getOrderName());
092            result.setEntityRef(order.getPrimaryKey().getEntityRef());
093        }
094
095        return result;
096    }
097
098}