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.job.server.command;
018
019import com.echothree.control.user.job.common.edit.JobDescriptionEdit;
020import com.echothree.control.user.job.common.edit.JobEditFactory;
021import com.echothree.control.user.job.common.result.EditJobDescriptionResult;
022import com.echothree.control.user.job.common.result.JobResultFactory;
023import com.echothree.control.user.job.common.spec.JobDescriptionSpec;
024import com.echothree.model.control.job.server.control.JobControl;
025import com.echothree.model.control.party.common.PartyTypes;
026import com.echothree.model.control.party.server.control.PartyControl;
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.util.common.command.EditMode;
032import com.echothree.util.common.message.ExecutionErrors;
033import com.echothree.util.common.validation.FieldDefinition;
034import com.echothree.util.common.validation.FieldType;
035import com.echothree.util.server.control.BaseAbstractEditCommand;
036import com.echothree.util.server.control.CommandSecurityDefinition;
037import com.echothree.util.server.control.PartyTypeDefinition;
038import com.echothree.util.server.control.SecurityRoleDefinition;
039import java.util.List;
040import javax.enterprise.context.Dependent;
041import javax.inject.Inject;
042
043@Dependent
044public class EditJobDescriptionCommand
045        extends BaseAbstractEditCommand<JobDescriptionSpec, JobDescriptionEdit, EditJobDescriptionResult, JobDescription, Job> {
046    
047    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
048    private final static List<FieldDefinition> SPEC_FIELD_DEFINITIONS;
049    private final static List<FieldDefinition> EDIT_FIELD_DEFINITIONS;
050    
051    static {
052        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(List.of(
053                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
054                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
055                        new SecurityRoleDefinition(SecurityRoleGroups.Job.name(), SecurityRoles.Description.name())
056                ))
057        ));
058        
059        SPEC_FIELD_DEFINITIONS = List.of(
060                new FieldDefinition("JobName", FieldType.ENTITY_NAME, true, null, null),
061                new FieldDefinition("LanguageIsoName", FieldType.ENTITY_NAME, true, null, null)
062        );
063        
064        EDIT_FIELD_DEFINITIONS = List.of(
065                new FieldDefinition("Description", FieldType.STRING, true, 1L, 132L)
066        );
067    }
068
069    @Inject
070    JobControl jobControl;
071
072    @Inject
073    PartyControl partyControl;
074
075
076    /** Creates a new instance of EditJobDescriptionCommand */
077    public EditJobDescriptionCommand() {
078        super(COMMAND_SECURITY_DEFINITION, SPEC_FIELD_DEFINITIONS, EDIT_FIELD_DEFINITIONS);
079    }
080
081    @Override
082    protected EditJobDescriptionResult getResult() {
083        return JobResultFactory.getEditJobDescriptionResult();
084    }
085
086    @Override
087    protected JobDescriptionEdit getEdit() {
088        return JobEditFactory.getJobDescriptionEdit();
089    }
090
091    @Override
092    protected JobDescription getEntity(EditJobDescriptionResult result) {
093        JobDescription jobDescription = null;
094        var jobName = spec.getJobName();
095        var job = jobControl.getJobByName(jobName);
096
097        if(job != null) {
098            var languageIsoName = spec.getLanguageIsoName();
099            var language = partyControl.getLanguageByIsoName(languageIsoName);
100
101            if(language != null) {
102                if(editMode.equals(EditMode.LOCK) || editMode.equals(EditMode.ABANDON)) {
103                    jobDescription = jobControl.getJobDescription(job, language);
104                } else { // EditMode.UPDATE
105                    jobDescription = jobControl.getJobDescriptionForUpdate(job, language);
106                }
107
108                if(jobDescription == null) {
109                    addExecutionError(ExecutionErrors.UnknownJobDescription.name(), jobName, languageIsoName);
110                }
111            } else {
112                addExecutionError(ExecutionErrors.UnknownLanguageIsoName.name(), languageIsoName);
113            }
114        } else {
115            addExecutionError(ExecutionErrors.UnknownJobName.name(), jobName);
116        }
117
118        return jobDescription;
119    }
120
121    @Override
122    protected Job getLockEntity(JobDescription jobDescription) {
123        return jobDescription.getJob();
124    }
125
126    @Override
127    protected void fillInResult(EditJobDescriptionResult result, JobDescription jobDescription) {
128        result.setJobDescription(jobControl.getJobDescriptionTransfer(getUserVisit(), jobDescription));
129    }
130
131    @Override
132    protected void doLock(JobDescriptionEdit edit, JobDescription jobDescription) {
133        edit.setDescription(jobDescription.getDescription());
134    }
135
136    @Override
137    protected void doUpdate(JobDescription jobDescription) {
138        var jobDescriptionValue = jobControl.getJobDescriptionValue(jobDescription);
139
140        jobDescriptionValue.setDescription(edit.getDescription());
141
142        jobControl.updateJobDescriptionFromValue(jobDescriptionValue, getPartyPK());
143    }
144    
145}