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.edit.SalesEditFactory;
020import com.echothree.control.user.sales.common.edit.SalesOrderLineTimeEdit;
021import com.echothree.control.user.sales.common.form.EditSalesOrderLineTimeForm;
022import com.echothree.control.user.sales.common.result.EditSalesOrderLineTimeResult;
023import com.echothree.control.user.sales.common.result.SalesResultFactory;
024import com.echothree.control.user.sales.common.spec.SalesOrderLineTimeSpec;
025import com.echothree.model.control.order.server.control.OrderTimeControl;
026import com.echothree.model.control.sales.server.logic.SalesOrderLineLogic;
027import com.echothree.model.data.order.server.entity.Order;
028import com.echothree.model.data.order.server.entity.OrderLine;
029import com.echothree.model.data.order.server.entity.OrderLineTime;
030import com.echothree.model.data.order.server.entity.OrderTimeType;
031import com.echothree.model.data.order.server.entity.OrderType;
032import com.echothree.model.data.order.server.value.OrderLineTimeValue;
033import com.echothree.model.data.user.common.pk.UserVisitPK;
034import com.echothree.util.common.command.EditMode;
035import com.echothree.util.common.message.ExecutionErrors;
036import com.echothree.util.common.validation.FieldDefinition;
037import com.echothree.util.common.validation.FieldType;
038import com.echothree.util.server.control.BaseAbstractEditCommand;
039import com.echothree.util.server.persistence.Session;
040import com.echothree.util.server.string.DateUtils;
041import java.util.Arrays;
042import java.util.Collections;
043import java.util.List;
044
045public class EditSalesOrderLineTimeCommand
046        extends BaseAbstractEditCommand<SalesOrderLineTimeSpec, SalesOrderLineTimeEdit, EditSalesOrderLineTimeResult, OrderLineTime, Order> {
047
048    private final static List<FieldDefinition> SPEC_FIELD_DEFINITIONS;
049    private final static List<FieldDefinition> EDIT_FIELD_DEFINITIONS;
050
051    static {
052        SPEC_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
053                new FieldDefinition("OrderName", FieldType.ENTITY_NAME, true, null, null),
054                new FieldDefinition("OrderLineSequence", FieldType.UNSIGNED_INTEGER, true, null, null),
055                new FieldDefinition("OrderTimeTypeName", FieldType.ENTITY_NAME, true, null, null)
056                ));
057
058        EDIT_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
059                new FieldDefinition("Time", FieldType.DATE_TIME, true, null, null)
060                ));
061    }
062
063    /** Creates a new instance of EditSalesOrderLineTimeCommand */
064    public EditSalesOrderLineTimeCommand(UserVisitPK userVisitPK, EditSalesOrderLineTimeForm form) {
065        super(userVisitPK, form, null, SPEC_FIELD_DEFINITIONS, EDIT_FIELD_DEFINITIONS);
066    }
067
068    @Override
069    public EditSalesOrderLineTimeResult getResult() {
070        return SalesResultFactory.getEditSalesOrderLineTimeResult();
071    }
072
073    @Override
074    public SalesOrderLineTimeEdit getEdit() {
075        return SalesEditFactory.getSalesOrderLineTimeEdit();
076    }
077
078    @Override
079    public OrderLineTime getEntity(EditSalesOrderLineTimeResult result) {
080        String orderName = spec.getOrderName();
081        String orderLineSequence = spec.getOrderLineSequence();
082        OrderLine orderLine = SalesOrderLineLogic.getInstance().getOrderLineByName(this, orderName, orderLineSequence);
083        OrderLineTime orderLineTime = null;
084        
085        if(!hasExecutionErrors()) {
086            var orderTimeControl = Session.getModelController(OrderTimeControl.class);
087            OrderType orderType = orderLine.getLastDetail().getOrder().getLastDetail().getOrderType();
088            String orderTimeTypeName = spec.getOrderTimeTypeName();
089            OrderTimeType orderTimeType = orderTimeControl.getOrderTimeTypeByName(orderType, orderTimeTypeName);
090
091            if(orderTimeType != null) {
092                if(editMode.equals(EditMode.LOCK) || editMode.equals(EditMode.ABANDON)) {
093                    orderLineTime = orderTimeControl.getOrderLineTime(orderLine, orderTimeType);
094                } else { // EditMode.UPDATE
095                    orderLineTime = orderTimeControl.getOrderLineTimeForUpdate(orderLine, orderTimeType);
096                }
097
098                if(orderLineTime == null) {
099                    addExecutionError(ExecutionErrors.UnknownOrderLineTime.name(), orderType.getLastDetail().getOrderTypeName(), orderName, orderTimeTypeName);
100                }
101            }
102        }
103        
104        return orderLineTime;
105    }
106
107    @Override
108    public Order getLockEntity(OrderLineTime orderLineTime) {
109        return orderLineTime.getOrderLine().getLastDetail().getOrder();
110    }
111
112    @Override
113    public void fillInResult(EditSalesOrderLineTimeResult result, OrderLineTime orderLineTime) {
114        var orderTimeControl = Session.getModelController(OrderTimeControl.class);
115
116        result.setOrderLineTime(orderTimeControl.getOrderLineTimeTransfer(getUserVisit(), orderLineTime));
117    }
118
119    @Override
120    public void doLock(SalesOrderLineTimeEdit edit, OrderLineTime orderLineTime) {
121        edit.setTime(DateUtils.getInstance().formatTypicalDateTime(getUserVisit(), getPreferredDateTimeFormat(), orderLineTime.getTime()));
122    }
123
124    @Override
125    public void doUpdate(OrderLineTime orderLineTime) {
126        var orderTimeControl = Session.getModelController(OrderTimeControl.class);
127        OrderLineTimeValue orderLineTimeValue = orderTimeControl.getOrderLineTimeValue(orderLineTime);
128        Long time = Long.valueOf(edit.getTime());
129        
130        orderLineTimeValue.setTime(time);
131
132        orderTimeControl.updateOrderLineTimeFromValue(orderLineTimeValue, getPartyPK());
133    }
134
135}