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.form.GetJobForm;
020import com.echothree.control.user.job.common.result.GetJobResult;
021import com.echothree.control.user.job.common.result.JobResultFactory;
022import com.echothree.model.control.core.common.EventTypes;
023import com.echothree.model.control.job.server.control.JobControl;
024import com.echothree.model.control.party.common.PartyTypes;
025import com.echothree.model.control.security.common.SecurityRoleGroups;
026import com.echothree.model.control.security.common.SecurityRoles;
027import com.echothree.model.data.job.server.entity.Job;
028import com.echothree.model.data.user.common.pk.UserVisitPK;
029import com.echothree.util.common.message.ExecutionErrors;
030import com.echothree.util.common.validation.FieldDefinition;
031import com.echothree.util.common.validation.FieldType;
032import com.echothree.util.common.command.BaseResult;
033import com.echothree.util.server.control.BaseSimpleCommand;
034import com.echothree.util.server.control.CommandSecurityDefinition;
035import com.echothree.util.server.control.PartyTypeDefinition;
036import com.echothree.util.server.control.SecurityRoleDefinition;
037import com.echothree.util.server.persistence.Session;
038import java.util.Arrays;
039import java.util.Collections;
040import java.util.List;
041
042public class GetJobCommand
043        extends BaseSimpleCommand<GetJobForm> {
044    
045    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
046    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
047    
048    static {
049        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(Collections.unmodifiableList(Arrays.asList(
050                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
051                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), Collections.unmodifiableList(Arrays.asList(
052                        new SecurityRoleDefinition(SecurityRoleGroups.Job.name(), SecurityRoles.Review.name())
053                        )))
054                )));
055        
056        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
057            new FieldDefinition("JobName", FieldType.ENTITY_NAME, true, null, null)
058        ));
059    }
060    
061    /** Creates a new instance of GetJobCommand */
062    public GetJobCommand(UserVisitPK userVisitPK, GetJobForm form) {
063        super(userVisitPK, form, COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, true);
064    }
065    
066    @Override
067    protected BaseResult execute() {
068        var jobControl = Session.getModelController(JobControl.class);
069        GetJobResult result = JobResultFactory.getGetJobResult();
070        String jobName = form.getJobName();
071        Job job = jobControl.getJobByName(jobName);
072        
073        if(job != null) {
074            result.setJob(jobControl.getJobTransfer(getUserVisit(), job));
075            
076            sendEvent(job.getPrimaryKey(), EventTypes.READ, null, null, getPartyPK());
077        } else {
078            addExecutionError(ExecutionErrors.UnknownJobName.name(), jobName);
079        }
080        
081        return result;
082    }
083    
084}