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.job.server.command;
018
019import com.echothree.control.user.job.common.edit.JobEdit;
020import com.echothree.control.user.job.common.edit.JobEditFactory;
021import com.echothree.control.user.job.common.form.EditJobForm;
022import com.echothree.control.user.job.common.result.EditJobResult;
023import com.echothree.control.user.job.common.result.JobResultFactory;
024import com.echothree.control.user.job.common.spec.JobSpec;
025import com.echothree.model.control.job.server.control.JobControl;
026import com.echothree.model.control.party.common.PartyTypes;
027import com.echothree.model.control.security.common.SecurityRoleGroups;
028import com.echothree.model.control.security.common.SecurityRoles;
029import com.echothree.model.data.job.server.entity.Job;
030import com.echothree.model.data.job.server.entity.JobDescription;
031import com.echothree.model.data.job.server.entity.JobDetail;
032import com.echothree.model.data.job.server.value.JobDescriptionValue;
033import com.echothree.model.data.job.server.value.JobDetailValue;
034import com.echothree.model.data.user.common.pk.UserVisitPK;
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.common.command.BaseResult;
039import com.echothree.util.common.command.EditMode;
040import com.echothree.util.server.control.BaseEditCommand;
041import com.echothree.util.server.control.CommandSecurityDefinition;
042import com.echothree.util.server.control.PartyTypeDefinition;
043import com.echothree.util.server.control.SecurityRoleDefinition;
044import com.echothree.util.server.persistence.Session;
045import java.util.Arrays;
046import java.util.Collections;
047import java.util.List;
048
049public class EditJobCommand
050        extends BaseEditCommand<JobSpec, JobEdit> {
051    
052    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
053    private final static List<FieldDefinition> SPEC_FIELD_DEFINITIONS;
054    private final static List<FieldDefinition> EDIT_FIELD_DEFINITIONS;
055    
056    static {
057        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(Collections.unmodifiableList(Arrays.asList(
058                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
059                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), Collections.unmodifiableList(Arrays.asList(
060                    new SecurityRoleDefinition(SecurityRoleGroups.Job.name(), SecurityRoles.Edit.name())
061                    )))
062                )));
063        
064        SPEC_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
065                new FieldDefinition("JobName", FieldType.ENTITY_NAME, true, null, null)
066                ));
067        
068        EDIT_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
069                new FieldDefinition("JobName", FieldType.ENTITY_NAME, true, null, null),
070                new FieldDefinition("SortOrder", FieldType.SIGNED_INTEGER, true, null, null),
071                new FieldDefinition("Description", FieldType.STRING, false, 1L, 132L)
072                ));
073    }
074    
075    /** Creates a new instance of EditJobCommand */
076    public EditJobCommand(UserVisitPK userVisitPK, EditJobForm form) {
077        super(userVisitPK, form, COMMAND_SECURITY_DEFINITION, SPEC_FIELD_DEFINITIONS, EDIT_FIELD_DEFINITIONS);
078    }
079    
080    @Override
081    protected BaseResult execute() {
082        var jobControl = Session.getModelController(JobControl.class);
083        EditJobResult result = JobResultFactory.getEditJobResult();
084        
085        if(editMode.equals(EditMode.LOCK)) {
086            String jobName = spec.getJobName();
087            Job job = jobControl.getJobByName(jobName);
088            
089            if(job != null) {
090                result.setJob(jobControl.getJobTransfer(getUserVisit(), job));
091                
092                if(lockEntity(job)) {
093                    JobDescription jobDescription = jobControl.getJobDescription(job, getPreferredLanguage());
094                    JobEdit edit = JobEditFactory.getJobEdit();
095                    JobDetail jobDetail = job.getLastDetail();
096                    
097                    result.setEdit(edit);
098                    edit.setJobName(jobDetail.getJobName());
099                    edit.setSortOrder(jobDetail.getSortOrder().toString());
100                    
101                    if(jobDescription != null)
102                        edit.setDescription(jobDescription.getDescription());
103                } else {
104                    addExecutionError(ExecutionErrors.EntityLockFailed.name());
105                }
106                
107                result.setEntityLock(getEntityLockTransfer(job));
108            } else {
109                addExecutionError(ExecutionErrors.UnknownJobName.name(), jobName);
110            }
111        } else if(editMode.equals(EditMode.UPDATE)) {
112            String jobName = spec.getJobName();
113            Job job = jobControl.getJobByNameForUpdate(jobName);
114            
115            if(job != null) {
116                jobName = edit.getJobName();
117                Job duplicateJob = jobControl.getJobByName(jobName);
118                
119                if(duplicateJob == null || job.equals(duplicateJob)) {
120                    if(lockEntityForUpdate(job)) {
121                        try {
122                            var partyPK = getPartyPK();
123                            JobDetailValue jobDetailValue = jobControl.getJobDetailValueForUpdate(job);
124                            JobDescription jobDescription = jobControl.getJobDescriptionForUpdate(job, getPreferredLanguage());
125                            String description = edit.getDescription();
126                            
127                            jobDetailValue.setJobName(edit.getJobName());
128                            jobDetailValue.setSortOrder(Integer.valueOf(edit.getSortOrder()));
129                            
130                            jobControl.updateJobFromValue(jobDetailValue, partyPK);
131                            
132                            if(jobDescription == null && description != null) {
133                                jobControl.createJobDescription(job, getPreferredLanguage(), description, partyPK);
134                            } else if(jobDescription != null && description == null) {
135                                jobControl.deleteJobDescription(jobDescription, partyPK);
136                            } else if(jobDescription != null && description != null) {
137                                JobDescriptionValue jobDescriptionValue = jobControl.getJobDescriptionValue(jobDescription);
138                                
139                                jobDescriptionValue.setDescription(description);
140                                jobControl.updateJobDescriptionFromValue(jobDescriptionValue, partyPK);
141                            }
142                        } finally {
143                            unlockEntity(job);
144                        }
145                    } else {
146                        addExecutionError(ExecutionErrors.EntityLockStale.name());
147                    }
148                } else {
149                    addExecutionError(ExecutionErrors.DuplicateJobName.name(), jobName);
150                }
151            } else {
152                addExecutionError(ExecutionErrors.UnknownJobName.name(), jobName);
153            }
154            
155            if(hasExecutionErrors()) {
156                result.setJob(jobControl.getJobTransfer(getUserVisit(), job));
157                result.setEntityLock(getEntityLockTransfer(job));
158            }
159        }
160        
161        return result;
162    }
163    
164}