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.employee.server.command;
018
019import com.echothree.control.user.employee.common.edit.EmployeeEditFactory;
020import com.echothree.control.user.employee.common.edit.LeaveEdit;
021import com.echothree.control.user.employee.common.form.EditLeaveForm;
022import com.echothree.control.user.employee.common.result.EditLeaveResult;
023import com.echothree.control.user.employee.common.result.EmployeeResultFactory;
024import com.echothree.control.user.employee.common.spec.LeaveSpec;
025import com.echothree.model.control.employee.server.control.EmployeeControl;
026import com.echothree.model.control.employee.server.logic.LeaveLogic;
027import com.echothree.model.control.party.common.PartyTypes;
028import com.echothree.model.control.party.server.control.PartyControl;
029import com.echothree.model.control.security.common.SecurityRoleGroups;
030import com.echothree.model.control.security.common.SecurityRoles;
031import com.echothree.model.control.uom.common.UomConstants;
032import com.echothree.model.control.uom.server.logic.UnitOfMeasureTypeLogic;
033import com.echothree.model.control.employee.common.workflow.LeaveStatusConstants;
034import com.echothree.model.control.workflow.server.logic.WorkflowStepLogic;
035import com.echothree.model.data.employee.server.entity.Leave;
036import com.echothree.model.data.employee.server.entity.LeaveReason;
037import com.echothree.model.data.employee.server.entity.LeaveType;
038import com.echothree.model.data.party.server.entity.PartyCompany;
039import com.echothree.model.data.user.common.pk.UserVisitPK;
040import com.echothree.util.common.message.ExecutionErrors;
041import com.echothree.util.common.validation.FieldDefinition;
042import com.echothree.util.common.validation.FieldType;
043import com.echothree.util.common.command.EditMode;
044import com.echothree.util.server.control.BaseAbstractEditCommand;
045import com.echothree.util.server.control.CommandSecurityDefinition;
046import com.echothree.util.server.control.PartyTypeDefinition;
047import com.echothree.util.server.control.SecurityRoleDefinition;
048import com.echothree.util.server.persistence.Session;
049import com.echothree.util.server.string.DateUtils;
050import java.util.List;
051import javax.enterprise.context.Dependent;
052
053@Dependent
054public class EditLeaveCommand
055        extends BaseAbstractEditCommand<LeaveSpec, LeaveEdit, EditLeaveResult, Leave, Leave> {
056
057    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
058    private final static List<FieldDefinition> SPEC_FIELD_DEFINITIONS;
059    private final static List<FieldDefinition> EDIT_FIELD_DEFINITIONS;
060
061    static {
062        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(List.of(
063                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
064                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
065                    new SecurityRoleDefinition(SecurityRoleGroups.Leave.name(), SecurityRoles.Edit.name())
066                    ))
067                ));
068        
069        SPEC_FIELD_DEFINITIONS = List.of(
070                new FieldDefinition("LeaveName", FieldType.ENTITY_NAME, true, null, null)
071                );
072
073        EDIT_FIELD_DEFINITIONS = List.of(
074                new FieldDefinition("CompanyName", FieldType.ENTITY_NAME, true, null, null),
075                new FieldDefinition("StartTime", FieldType.DATE_TIME, true, null, null),
076                new FieldDefinition("EndTime", FieldType.DATE_TIME, false, null, null),
077                new FieldDefinition("TotalTime", FieldType.UNSIGNED_LONG, false, null, null),
078                new FieldDefinition("TotalTimeUnitOfMeasureTypeName", FieldType.ENTITY_NAME, false, null, null),
079                new FieldDefinition("LeaveTypeName", FieldType.ENTITY_NAME, true, null, null),
080                new FieldDefinition("LeaveReasonName", FieldType.ENTITY_NAME, true, null, null)
081                );
082    }
083
084    /** Creates a new instance of EditLeaveCommand */
085    public EditLeaveCommand() {
086        super(COMMAND_SECURITY_DEFINITION, SPEC_FIELD_DEFINITIONS, EDIT_FIELD_DEFINITIONS);
087    }
088
089    @Override
090    public EditLeaveResult getResult() {
091        return EmployeeResultFactory.getEditLeaveResult();
092    }
093
094    @Override
095    public LeaveEdit getEdit() {
096        return EmployeeEditFactory.getLeaveEdit();
097    }
098
099    @Override
100    public Leave getEntity(EditLeaveResult result) {
101        var employeeControl = Session.getModelController(EmployeeControl.class);
102        Leave leave;
103        var leaveName = spec.getLeaveName();
104
105        if(editMode.equals(EditMode.LOCK) || editMode.equals(EditMode.ABANDON)) {
106            leave = employeeControl.getLeaveByName(leaveName);
107        } else { // EditMode.UPDATE
108            leave = employeeControl.getLeaveByNameForUpdate(leaveName);
109        }
110
111        if(leave == null) {
112            addExecutionError(ExecutionErrors.UnknownLeave.name(), leaveName);
113        }
114
115        return leave;
116    }
117
118    @Override
119    public Leave getLockEntity(Leave leave) {
120        return leave;
121    }
122
123    @Override
124    public void fillInResult(EditLeaveResult result, Leave leave) {
125        var employeeControl = Session.getModelController(EmployeeControl.class);
126
127        result.setLeave(employeeControl.getLeaveTransfer(getUserVisit(), leave));
128    }
129
130    Long endTime;
131    
132    @Override
133    public void doLock(LeaveEdit edit, Leave leave) {
134        var partyControl = Session.getModelController(PartyControl.class);
135        var unitOfMeasureTypeLogic = UnitOfMeasureTypeLogic.getInstance();
136        var leaveDetail = leave.getLastDetail();
137        UnitOfMeasureTypeLogic.StringUnitOfMeasure stringUnitOfMeasure;
138        
139        endTime = leaveDetail.getEndTime();
140
141        edit.setCompanyName(partyControl.getPartyCompany(leaveDetail.getCompanyParty()).getPartyCompanyName());
142        edit.setStartTime(DateUtils.getInstance().formatTypicalDateTime(getUserVisit(), getPreferredDateTimeFormat(), leaveDetail.getStartTime()));
143        edit.setEndTime(endTime == null ? null : DateUtils.getInstance().formatTypicalDateTime(getUserVisit(), getPreferredDateTimeFormat(), endTime));
144        stringUnitOfMeasure = unitOfMeasureTypeLogic.unitOfMeasureToString(this, UomConstants.UnitOfMeasureKindUseType_TIME, leaveDetail.getTotalTime());
145        edit.setTotalTimeUnitOfMeasureTypeName(stringUnitOfMeasure.getUnitOfMeasureTypeName());
146        edit.setTotalTime(stringUnitOfMeasure.getValue());
147        edit.setLeaveTypeName(leaveDetail.getLeaveType().getLastDetail().getLeaveTypeName());
148        edit.setLeaveReasonName(leaveDetail.getLeaveReason().getLastDetail().getLeaveReasonName());
149    }
150
151    @Override
152    public void canEdit(Leave leave) {
153        if(WorkflowStepLogic.getInstance().isEntityInWorkflowStepsForUpdate(null, LeaveStatusConstants.Workflow_LEAVE_STATUS, leave,
154                LeaveStatusConstants.WorkflowStep_APPROVED, LeaveStatusConstants.WorkflowStep_DENIED, LeaveStatusConstants.WorkflowStep_SUBMITTED).isEmpty()) {
155            addExecutionError(ExecutionErrors.InvalidLeaveStatus.name(), leave.getLastDetail().getLeaveName());
156        }
157    }
158    
159    PartyCompany partyCompany;
160    LeaveType leaveType;
161    LeaveReason leaveReason;
162    Long startTime;
163    Long totalTime;
164
165    @Override
166    public void canUpdate(Leave leave) {
167        var partyControl = Session.getModelController(PartyControl.class);
168        var companyName = edit.getCompanyName();
169
170        partyCompany = partyControl.getPartyCompanyByName(companyName);
171
172        if(partyCompany != null) {
173            var unitOfMeasureTypeLogic = UnitOfMeasureTypeLogic.getInstance();
174            
175            totalTime = unitOfMeasureTypeLogic.checkUnitOfMeasure(this, UomConstants.UnitOfMeasureKindUseType_TIME,
176                    edit.getTotalTime(), edit.getTotalTimeUnitOfMeasureTypeName(),
177                    null, ExecutionErrors.MissingRequiredTotalTime.name(), null, ExecutionErrors.MissingRequiredTotalTimeUnitOfMeasureTypeName.name(),
178                    null, ExecutionErrors.UnknownTotalTimeUnitOfMeasureTypeName.name());
179
180            if(!hasExecutionErrors()) {
181                var employeeControl = Session.getModelController(EmployeeControl.class);
182                var leaveTypeName = edit.getLeaveTypeName();
183
184                leaveType = employeeControl.getLeaveTypeByName(leaveTypeName);
185
186                if(leaveTypeName == null || leaveType != null) {
187                    var leaveReasonName = edit.getLeaveReasonName();
188
189                    leaveReason = employeeControl.getLeaveReasonByName(leaveReasonName);
190
191                    if(leaveReasonName == null || leaveReason != null) {
192                        var strEndTime = edit.getEndTime();
193
194                        startTime = Long.valueOf(edit.getStartTime());
195                        endTime = strEndTime == null ? null : Long.valueOf(strEndTime);
196
197                        if(endTime != null && !(endTime > startTime)) {
198                            addExecutionError(endTime.equals(startTime) ? ExecutionErrors.EndTimeEqualToStartTime.name() : ExecutionErrors.EndTimeBeforeStartTime.name());
199                        }
200                    } else {
201                        addExecutionError(ExecutionErrors.UnknownLeaveReasonName.name(), leaveReasonName);
202                    }
203                } else {
204                    addExecutionError(ExecutionErrors.UnknownLeaveTypeName.name(), leaveTypeName);
205                }
206            }
207        } else {
208            addExecutionError(ExecutionErrors.UnknownCompanyName.name(), companyName);
209        }
210    }
211
212    @Override
213    public void doUpdate(Leave leave) {
214        var employeeControl = Session.getModelController(EmployeeControl.class);
215        var leaveDetailValue = employeeControl.getLeaveDetailValueForUpdate(leave);
216
217        leaveDetailValue.setCompanyPartyPK(partyCompany.getPartyPK());
218        leaveDetailValue.setLeaveTypePK(leaveType.getPrimaryKey());
219        leaveDetailValue.setLeaveReasonPK(leaveReason.getPrimaryKey());
220        leaveDetailValue.setStartTime(startTime);
221        leaveDetailValue.setEndTime(endTime);
222        leaveDetailValue.setTotalTime(totalTime);
223
224        LeaveLogic.getInstance().updateLeaveFromValue(null, leaveDetailValue, getPartyPK());
225    }
226
227}