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