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.string.DateUtils;
049import java.util.List;
050import javax.enterprise.context.Dependent;
051import javax.inject.Inject;
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    @Inject
085    EmployeeControl employeeControl;
086
087    @Inject
088    PartyControl partyControl;
089
090    @Inject
091    LeaveLogic leaveLogic;
092
093    @Inject
094    UnitOfMeasureTypeLogic unitOfMeasureTypeLogic;
095
096    @Inject
097    WorkflowStepLogic workflowStepLogic;
098
099    /** Creates a new instance of EditLeaveCommand */
100    public EditLeaveCommand() {
101        super(COMMAND_SECURITY_DEFINITION, SPEC_FIELD_DEFINITIONS, EDIT_FIELD_DEFINITIONS);
102    }
103
104    @Override
105    public EditLeaveResult getResult() {
106        return EmployeeResultFactory.getEditLeaveResult();
107    }
108
109    @Override
110    public LeaveEdit getEdit() {
111        return EmployeeEditFactory.getLeaveEdit();
112    }
113
114    @Override
115    public Leave getEntity(EditLeaveResult result) {
116        Leave leave;
117        var leaveName = spec.getLeaveName();
118
119        if(editMode.equals(EditMode.LOCK) || editMode.equals(EditMode.ABANDON)) {
120            leave = employeeControl.getLeaveByName(leaveName);
121        } else { // EditMode.UPDATE
122            leave = employeeControl.getLeaveByNameForUpdate(leaveName);
123        }
124
125        if(leave == null) {
126            addExecutionError(ExecutionErrors.UnknownLeave.name(), leaveName);
127        }
128
129        return leave;
130    }
131
132    @Override
133    public Leave getLockEntity(Leave leave) {
134        return leave;
135    }
136
137    @Override
138    public void fillInResult(EditLeaveResult result, Leave leave) {
139        result.setLeave(employeeControl.getLeaveTransfer(getUserVisit(), leave));
140    }
141
142    Long endTime;
143    
144    @Override
145    public void doLock(LeaveEdit edit, Leave leave) {
146        var leaveDetail = leave.getLastDetail();
147        UnitOfMeasureTypeLogic.StringUnitOfMeasure stringUnitOfMeasure;
148        
149        endTime = leaveDetail.getEndTime();
150
151        edit.setCompanyName(partyControl.getPartyCompany(leaveDetail.getCompanyParty()).getPartyCompanyName());
152        edit.setStartTime(DateUtils.getInstance().formatTypicalDateTime(getUserVisit(), getPreferredDateTimeFormat(), leaveDetail.getStartTime()));
153        edit.setEndTime(endTime == null ? null : DateUtils.getInstance().formatTypicalDateTime(getUserVisit(), getPreferredDateTimeFormat(), endTime));
154        stringUnitOfMeasure = unitOfMeasureTypeLogic.unitOfMeasureToString(this, UomConstants.UnitOfMeasureKindUseType_TIME, leaveDetail.getTotalTime());
155        edit.setTotalTimeUnitOfMeasureTypeName(stringUnitOfMeasure.getUnitOfMeasureTypeName());
156        edit.setTotalTime(stringUnitOfMeasure.getValue());
157        edit.setLeaveTypeName(leaveDetail.getLeaveType().getLastDetail().getLeaveTypeName());
158        edit.setLeaveReasonName(leaveDetail.getLeaveReason().getLastDetail().getLeaveReasonName());
159    }
160
161    @Override
162    public void canEdit(Leave leave) {
163        if(workflowStepLogic.isEntityInWorkflowStepsForUpdate(null, LeaveStatusConstants.Workflow_LEAVE_STATUS, leave,
164                LeaveStatusConstants.WorkflowStep_APPROVED, LeaveStatusConstants.WorkflowStep_DENIED, LeaveStatusConstants.WorkflowStep_SUBMITTED).isEmpty()) {
165            addExecutionError(ExecutionErrors.InvalidLeaveStatus.name(), leave.getLastDetail().getLeaveName());
166        }
167    }
168    
169    PartyCompany partyCompany;
170    LeaveType leaveType;
171    LeaveReason leaveReason;
172    Long startTime;
173    Long totalTime;
174
175    @Override
176    public void canUpdate(Leave leave) {
177        var companyName = edit.getCompanyName();
178
179        partyCompany = partyControl.getPartyCompanyByName(companyName);
180
181        if(partyCompany != null) {
182            totalTime = unitOfMeasureTypeLogic.checkUnitOfMeasure(this, UomConstants.UnitOfMeasureKindUseType_TIME,
183                    edit.getTotalTime(), edit.getTotalTimeUnitOfMeasureTypeName(),
184                    null, ExecutionErrors.MissingRequiredTotalTime.name(), null, ExecutionErrors.MissingRequiredTotalTimeUnitOfMeasureTypeName.name(),
185                    null, ExecutionErrors.UnknownTotalTimeUnitOfMeasureTypeName.name());
186
187            if(!hasExecutionErrors()) {
188                var leaveTypeName = edit.getLeaveTypeName();
189
190                leaveType = employeeControl.getLeaveTypeByName(leaveTypeName);
191
192                if(leaveTypeName == null || leaveType != null) {
193                    var leaveReasonName = edit.getLeaveReasonName();
194
195                    leaveReason = employeeControl.getLeaveReasonByName(leaveReasonName);
196
197                    if(leaveReasonName == null || leaveReason != null) {
198                        var strEndTime = edit.getEndTime();
199
200                        startTime = Long.valueOf(edit.getStartTime());
201                        endTime = strEndTime == null ? null : Long.valueOf(strEndTime);
202
203                        if(endTime != null && !(endTime > startTime)) {
204                            addExecutionError(endTime.equals(startTime) ? ExecutionErrors.EndTimeEqualToStartTime.name() : ExecutionErrors.EndTimeBeforeStartTime.name());
205                        }
206                    } else {
207                        addExecutionError(ExecutionErrors.UnknownLeaveReasonName.name(), leaveReasonName);
208                    }
209                } else {
210                    addExecutionError(ExecutionErrors.UnknownLeaveTypeName.name(), leaveTypeName);
211                }
212            }
213        } else {
214            addExecutionError(ExecutionErrors.UnknownCompanyName.name(), companyName);
215        }
216    }
217
218    @Override
219    public void doUpdate(Leave leave) {
220        var leaveDetailValue = employeeControl.getLeaveDetailValueForUpdate(leave);
221
222        leaveDetailValue.setCompanyPartyPK(partyCompany.getPartyPK());
223        leaveDetailValue.setLeaveTypePK(leaveType.getPrimaryKey());
224        leaveDetailValue.setLeaveReasonPK(leaveReason.getPrimaryKey());
225        leaveDetailValue.setStartTime(startTime);
226        leaveDetailValue.setEndTime(endTime);
227        leaveDetailValue.setTotalTime(totalTime);
228
229        leaveLogic.updateLeaveFromValue(null, leaveDetailValue, getPartyPK());
230    }
231
232}